Update README.md

2023-07-31 07:12:38 +01:00 · 2023-07-31 07:12:38 +01:00 · ad8d7f6964
commit ad8d7f6964
parent 975e5013ba
1 changed files with 17 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,18 @@
 # BOIIIWD
-BOIII GUI Workshop downloader
+- A GUI Workshop downloader meant for BO3 (boiii) build using PyQt5 <br>
+![image](https://github.com/faroukbmiled/BOIIIWD/assets/51106560/d8b68cc0-2d94-4d12-8f4c-0a11cc7616c5)
+
+## Pre Usage:
+- Place [SteamCMD](https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip) inside the same folder as the script and run it to do update and install
+  
+## Usage:
+- ```pip install -r requirements.txt```
+- ```python boiiiwd.py```
+
+## Compiling into an exe (pyinstaller):
+- ```pip install pyinstaller```
+- ```pyinstaller --noconfirm --onefile --windowed --name "BOIIIWD" --ascii  boiiiwd.py```
+  
+### Notes:
+. It saves your input except workshop id <br>
+. Excuse the progress bar its pretty shit atm