Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Huowl committed Oct 17, 2023
1 parent 021d317 commit e27c297
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ More detailed description of the [algorithms and methods](https://rostok.readthe
To modify the modules of the Rostok framework a user should install it in development mode:

* Create the environment using `conda env create -f environment.yml`
* Activate the environment `rostok`
* Activate the environment `conda activate rostok`
* Install the package in development mode `pip3 install -e .`

### Known issues
Expand Down
5 changes: 3 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
from pathlib import Path

sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, str(Path(__file__).parent / '../../'))
sys.path.insert(0, str(Path(__file__).parent / '../../rostok'))
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('../../rostok'))

#The master toctree document
master_doc = 'index'
Expand Down
7 changes: 7 additions & 0 deletions docs/source/readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
=======
Read Me
=======


.. mdinclude:: ../../README_en.md
:literal:

0 comments on commit e27c297

Please sign in to comment.