diff --git a/README.md b/README.md index 3240b51..1403918 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,23 @@ -Quick & dirty commit of current progress to share with others. +# Installation +Don't. + +# Development installation + +Create a virtual environment and install the development set: ``` python -m venv venv source venv/bin/activate pip install --editable .[dev] +``` + +Set your save path and run the webserver to interact with the storage system: +``` +export D2SAVE_PATH="/path/to/saves" +flask --app d2warehouse.app run +``` + +Some debug tooling: +``` d2dump /path/to/stash.d2i ```