aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorduvallj <jediguy9@gmail.com>2019-02-02 13:32:01 -0500
committerduvallj <jediguy9@gmail.com>2019-02-02 13:32:01 -0500
commitce4cb0b5cd157c77396344958b403c41a4f0f8b3 (patch)
tree24834ded27cd08fbff997cb67e3f330043102609 /readme.md
parent39f07d92af6f363175f3c09ccbd73b4093b4f172 (diff)
downloadmodpackman-ce4cb0b5cd157c77396344958b403c41a4f0f8b3.tar.gz
modpackman-ce4cb0b5cd157c77396344958b403c41a4f0f8b3.zip
Update update.py (better argument parsing, documentation)
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/readme.md b/readme.md
index dc53e31..0438f1e 100644
--- a/readme.md
+++ b/readme.md
@@ -5,12 +5,15 @@ Script to update modpacks automatically
#### To Use
-Simply put the location of your `mods` folder in `pack-location.txt` and run `python update.py install`
+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 -r requirements.txt` to install all the Python module requirements.
-Requires the `requests` module.
+Simply put the location of your `mods` folder in `pack-location.txt` and run `python update.py install`
#### Maintenance:
-To check `downloads.txt` modlist for updates against `latest-urls.txt` modlist, run `python update.py check_updates`
+To check `downloads.txt` modlist for updates against `mods.txt` modlist, run `python update.py check_updates`.
+
+To automatically populate `downloads.txt` with the most recent versions of mods listed in `mods.txt` run `python update.py apply_updates`.
-To automatically populate `downloads.txt` with the most recent versions of mods listed in `latest-urls.txt` run `python update.py apply_updates`
+Finally, to actually install your mods from the list in `downloads.txt`, run `python update.py install`