Skip to content

Commit b37424c

Browse files
authored
Update README.md
1 parent 27e3481 commit b37424c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# ROOCS Website
22

3-
[![Build Status](https://travis-ci.org/roocs/roocs.github.io.svg?branch=master)](https://travis-ci.org/roocs/roocs.github.io)
4-
5-
*[ROOCS Website](https://roocs.github.io/)* is the front page for the roocs project.
3+
[ROOCS Website](https://roocs.github.io/) is the front page for the roocs project.
64

75
## Contributing
86

@@ -12,17 +10,20 @@ Contributions are welcome. Feel free to open a pull request with changes.
1210

1311
It can be helpful to preview changes on your computer before opening a pull request. *ROOCS website* uses the [MkDocs static site generator](https://www.mkdocs.org/). After forking or cloning the repository, perform the following steps to generate the site and preview it:
1412

15-
````
13+
```
14+
# build conda env with mkdcos
1615
conda env create
17-
1816
conda activate roocs
1917
18+
# build docs
2019
mkdocs build
2120
21+
# view docs locally
2222
mkdocs serve
23+
```
2324

2425
Open browser: http://127.0.0.1:8000
25-
```
26+
2627

2728
## Deployment
2829

0 commit comments

Comments
 (0)