diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 7525f83..54dd6fa 100644 --- a/README.md +++ b/README.md @@ -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="" +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 +```