diff --git a/README.md b/README.md index 1e27dcb..1d72ac9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # i3-workspace-reset Restore some order to your i3 workspaces + +## Development + +1. Create a virtual environment: `python -m venv venv` +2. Enter the virtual environment: `source venv/bin/active` +3. Install the requirements: `pip install -r requirements/development.txt` + +## Distribution + +1. Follow the instructions in the Development section +2. Generate the dist/ folder: `pyinstaller i3-workspace-reset.py` +3. Zip the dist/i3-workspace-reset/ folder: `zip -r i3-workspace-reset-#-#-#.zip i3-workspace-reset` + +## npm files? In a Python project?? Oh, the humanity! + +Don't worry, those files are just here to keep this file formatted with Prettier.