From 2dba98647fb9e9d64cd89f1f0de09ba686f534e8 Mon Sep 17 00:00:00 2001 From: comp500 Date: Sun, 22 Dec 2019 23:58:32 +0000 Subject: [PATCH] Add better initial documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 5e40aaa..0d280a2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # packwiz A command line tool for creating minecraft modpacks. + +## Installation +In future I will have a lot more installation options, but for now the easiest way is to compile from source. + +1. Install Go +2. Run `go install github.com/comp500/packwiz` + +## Getting Started +- Run `packwiz init` to create a modpack in the current folder +- Run `packwiz refresh` to update the index of mods +- Run `packwiz curseforge install [mod]` to install a mod from CurseForge +- Run `packwiz update *` to update all the mods in the modpack, or replace * with a mod to update it +- Run `packwiz curseforge export` to export the modpack in the format supported by the Twitch Launcher +- Use the `--help` flag for more information about any command