Update documentation

Fixes #26

README.md

@@ -3,15 +3,24 @@
 CharaChorder's all-in-one desktop app, supporting Linux, Windows, and MacOS.
 
 ## Build
-1. Get Python 3.11 (using [pyenv](https://github.com/pyenv/pyenv) recommended)
+1. Get Python >=3.11 (using [pyenv](https://github.com/pyenv/pyenv) recommended)
 2. Clone and build
-```
+```sh
 git clone https://github.com/CharaChorder/nexus
 cd nexus/
+python dist.py -nd
+```
+With the `-n` and `-d` flags, `dist.py` automatically detects your OS, sets up a virtualenv in the root directory of the repo (if not provided one via args), installs requirements, converts UI files to Python, sets up git hooks, and installs the nexus module locally.
+
+To develop, you can now run it from within the virtualenv (activate it first) using the `python -m nexus <args>` command.
+
+## Installation
+```sh
 python dist.py
 ```
+Running `dist.py` without any args detects your OS, sets up a virtualenv, installs reqs, converts UI files, and generates a platform-dependent executable in the `dist/` directory.
+
 Note: the CI-generated binaries (in releases) don't work at the moment (see [#6 CI doesn't work](https://github.com/CharaChorder/nexus/issues/6)).
-`dist.py` sets up a virtualenv in the root directory of the repo, and generates a platform-dependent executable in the `dist/` directory.
 
 ## Usage
 ```

dist.py

@@ -14,7 +14,9 @@
 parser = argparse.ArgumentParser(description="Build Nexus")
 parser.add_argument('-n', "--no-build", action="store_true", help="Skip building the executable, only setup")
 parser.add_argument('-d', "--devel", action="store_true", help="Install module locally and git hooks")
-parser.add_argument('-u', "--ui-only", action="store_true", help="Only convert ui files")
+parser.add_argument('-u', "--ui-only", action="store_true", help="Only convert ui files"
+                                                                 "(you must first have set up a venv and installed the"
+                                                                 "requirements to run this)")
 parser.add_argument("--venv-path", type=str, help="[Relative] path to virtual environment to use")
 args = parser.parse_args()