summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDominic DiTaranto <domdit@gmail.com>2024-07-30 22:38:58 -0400
committerDominic DiTaranto <domdit@gmail.com>2024-07-30 22:38:58 -0400
commitfd8124eb1dc763012baa1f55c5efa3d42e118f8d (patch)
tree58ca32aee72f9f4ad7e232ef085ba5f6223d0ce3 /README.md
parent393370abf7a1029e3d2526d2a9691a160e0248ab (diff)
updating readme, updating to run as bin script, updating logging and data to go in hidden dir in home dir
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 645d61d..4bf89ea 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,13 @@
2. Create and activate virtual environment
3. install requirements.txt
4. `python3 chandl.py <board> <thread_id>`
+5. ln -s full/path/to/chandl.py /usr/local/bin/chandl
+6. chmod +x /usr/local/bin/chandl
+ 1. NOTE: This will create a log file in your bin folder, and a data directory if you do not specify a specific path!
+
+### Arch Installation
+1. Clone Repository
+2. pacman -S python-beautifulsoup4 python-requests
### Explanation of Arguments
1. `board` - the board the thread is on like `gif` , `pol` , `wsg`