aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 80f43cd..13282e9 100644
--- a/readme.md
+++ b/readme.md
@@ -5,4 +5,18 @@ Script to update modpacks automatically
#### To Use
+First, install [Python 3](https://www.python.org/downloads/) and [Git](https://git-scm.com/downloads) and add them to your `$PATH`.
+Then, run `pip install requests` to install the Python Requests module (required to run the script).
+
Simply put the location of your `mods` folder in `pack-location.txt` and run `python update.py install`
+
+#### Maintenance:
+
+To check `version.txt` modlist for updates against `mods.txt` modlist, run `python update.py check_updates`.
+
+To automatically populate `version.txt` with the most recent versions of mods listed in `mods.txt` run `python update.py apply_updates`.
+
+Finally, to actually install mods from the list in `version.txt`, run `python update.py install`
+
+
+***NOTE***: `check_updates` and `apply_updates` require you have the `selenium` module installed