tworu/dzgui
1
0
Fork 0
mirror of https://github.com/aclist/dztui.git synced 2026-08-27 02:07:18 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: update build instructions

Browse Source
This commit is contained in:
aclist 2026-06-05 18:36:41 +09:00
parent 8edb38f175
commit 40e244e05a
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
DEVELOPERS.md
View File

@ -1,18 +1,22 @@
# TODO: link to here from sphinx docs
# Installing dev dependencies
uv pip install -e .[dev]
## Installing from source
# Setting up precommit hooks
pre-commit install
# Fetching submodules
### Fetch submodules
git submodule update --recursive --init
# Building documentation
### Install with dev dependencies
uv pip install -e '.[dev]'
## Miscellaneous
### Setting up precommit hooks
pre-commit install
### Building documentation
sphinx-build -M html source build -a
# Building standalone DZGUI release binaries
### Building standalone release binaries
1. Set up the build target: `rustup target add x86_64-unknown-linux-musl`
2. Run `python3 scripts/release.py`
3. Generate a release and tag against the bundled `dzgui` executable
3. Generate a release and tag against the resulting tarfile generated in `dist`