[+] Write run instructions in readme

This commit is contained in:
Hykilpikonna
2020-11-26 15:33:15 -05:00
parent a91307551d
commit c776ae3ca6
2 changed files with 53 additions and 0 deletions
Generated
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="" vcs="Git" />
</component>
</project>
+47
View File
@@ -1,2 +1,49 @@
# NetworkDiffBot
## How to Run
### 1. Clone Repository
```shell script
git clone https://github.com/hykilpikonna/NetworkDiffBot
cd NetworkDiffBot
```
### 2. Install Python Dependencies
(If you don't have Python 3.9 installed already, search about how to install Python 3.9 first)
```shell script
python3 -m venv ./venv
source ./venv/bin/activate
pip install -r requirements.txt
```
### 3. Create Start Script
Create File:
```shell script
nano start.sh
```
Script:
```shell script
export PYTHONPATH=PYTHONPATH:$pwd
export TG_TOKEN="<Your token here>"
python3 ./src/bot.py
# Then use Ctrl+X -> Y to save
```
Make it an executable:
```shell script
chmod +x start.sh
```
### 4. Run Script
```shell script
./start.sh
```