Updated README
This commit is contained in:
12
README.md
12
README.md
@@ -30,15 +30,19 @@ needs to be on its own line and any special characters should be escaped.
|
|||||||
|
|
||||||
## How To Use
|
## How To Use
|
||||||
1) Create a virtual environment (optional, but best practice)
|
1) Create a virtual environment (optional, but best practice)
|
||||||
|
```zsh
|
||||||
|
python3 -m venv ./.venv
|
||||||
|
source ./.venv/bin/activate
|
||||||
|
```
|
||||||
2) Use Pip to install all required packages
|
2) Use Pip to install all required packages
|
||||||
```python
|
```zsh
|
||||||
pip install -r requirements
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
3) Run the Orchestrator:
|
3) Run the Orchestrator:
|
||||||
```python
|
```zsh
|
||||||
python src/orchestrator.py
|
python src/orchestrator.py
|
||||||
```
|
```
|
||||||
OR
|
OR
|
||||||
```python
|
```zsh
|
||||||
python3 src/orchestrator.py
|
python3 src/orchestrator.py
|
||||||
```
|
```
|
||||||
Reference in New Issue
Block a user