-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Point to project documentation website
- Loading branch information
1 parent
bf0d753
commit 8faa6f9
Showing
1 changed file
with
3 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,9 @@ | ||
# 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: | ||
Refer to [the project documentation](https://smash-transport.github.io/smash-vhlle-hybrid/) for any information. | ||
|
||
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 | ||
|
||
## LICENSE | ||
### LICENSE | ||
|
||
Apart from the project logo, for which [CC-BY-ND](https://creativecommons.org/licenses/by-nd/4.0/) applies, the rest of the codebase is licensed under [GPLv3](LICENSE). |