From 40e244e05a1cefc91008b510b0c9df2d86018839 Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Fri, 5 Jun 2026 18:36:41 +0900 Subject: [PATCH] docs: update build instructions --- DEVELOPERS.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 886aae1..6aa180c 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -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`