From 9bb29c835bdc436d570092ae010594d8c3b72735 Mon Sep 17 00:00:00 2001 From: Alessandro Sciarra Date: Fri, 12 Apr 2024 12:06:59 +0200 Subject: [PATCH] Point to project documentation website --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 935ccb9..94cb9ae 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,8 @@ # SMASH-vHLLE-Hybrid - + -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