From fa1c87ff85ca83f0126dbc4ff276d93bbeadcfa1 Mon Sep 17 00:00:00 2001 From: rngesus-wept <33389307+rngesus-wept@users.noreply.github.com> Date: Sat, 25 Dec 2021 00:18:59 -0500 Subject: [PATCH] Improve usage instructions --- README.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 4fd7f56..da0a868 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,23 @@ Tabletop Simulator Mod Tools ---------------------------- -This is a collection of tools for working Tabletop Simulatator mods. +This is a collection of tools for working Tabletop Simulator mods. -To build a mod:: +To install (requires Python 3.7+):: - $ tts repack - -This will put the module at ``build/savegame.json``. You can also pass a path for where to build the module. + $ pip install tabletop-tools To unpack a module:: $ tts unpack <...path/to/savegame.json...> -to unpack a savegame. +to unpack a savegame to your current directory. + +To build a mod:: + + $ tts repack + +This will put the module at ``build/savegame.json``. You can also pass a path for where to build the module. Config