Update installation instructions in README.md
This commit is contained in:
parent
c7b9ea3e0e
commit
a65d0bba77
@ -1,21 +1,23 @@
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Install Python
|
1. Install `Python`
|
||||||
|
|
||||||
2. Create and activate your virtual environment following the [instructions](https://docs.python.org/3/tutorial/venv.html)
|
2. Install `python3-venv` by the following command: `apt install python3-venv`
|
||||||
|
|
||||||
3. Install the `requirements.txt` dependencies following the commands:
|
3. Create and activate your virtual environment following the [instructions](https://docs.python.org/3/tutorial/venv.html)
|
||||||
|
|
||||||
|
4. Install the `requirements.txt` dependencies following the commands:
|
||||||
```
|
```
|
||||||
cd ./scada_system
|
cd ./scada_system
|
||||||
pip install -r requirements.txt
|
pip3 install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Install the package in editable mode:
|
5. Install the package in editable mode:
|
||||||
```
|
```
|
||||||
pip install -e .
|
pip3 install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
5. To generate documentation in HTML format, you need to run the following commands:
|
6. To generate documentation in HTML format, you need to run the following commands:
|
||||||
```
|
```
|
||||||
cd ./docs
|
cd ./docs
|
||||||
make html
|
make html
|
||||||
|
Loading…
Reference in New Issue
Block a user