Skip to content

Commit

Permalink
Point to project documentation website
Browse files Browse the repository at this point in the history
  • Loading branch information
AxelKrypton committed Apr 12, 2024
1 parent bf0d753 commit 9bb29c8
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
# SMASH-vHLLE-Hybrid

<img src="https://github.com/smash-transport/new-hybrid-era/blob/main/docs/images/logo.png" align="right" width="25%"/>
<img src="https://github.com/smash-transport/smash-vhlle-hybrid/blob/main/docs/images/logo.png" align="right" width="25%"/>

This project is in a transition phase.
A website associated to this project with full documentation guides will be deployed soon.
For the moment you can serve it locally in few steps:

1. Get MkDocs and the used theme (once only, of course)
```
pip install mkdocs
pip install mkdocs-material
```
2. Run `mkdocs serve` from the top-level folder of this repository in your terminal
3. Open up [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your favorite browser
Refer to [the project documentation](https://smash-transport.github.io/smash-vhlle-hybrid/) for any information.

## LICENSE

Expand Down

0 comments on commit 9bb29c8

Please sign in to comment.