Skip to content
This repository has been archived by the owner on Jan 1, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kenneth Schnall committed Jun 14, 2020
1 parent 7a32970 commit 85869f8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 85869f8

Please sign in to comment.