Compare commits

..

2 Commits

Author SHA1 Message Date
aclist
c080847efc docs: mention atomic dpendency flags
Some checks failed
Mirror to Codeberg / mirror-to-codeberg (push) Has been cancelled
2026-06-05 18:56:19 +09:00
aclist
40e244e05a docs: update build instructions 2026-06-05 18:36:41 +09:00

View File

@ -1,18 +1,30 @@
# 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]'
This includes all dependencies for building, linting, testing, and checking in code.
If you optionally want to install only a subset of dev tools, replace 'dev' with the following flag:
build: package release deps
docs: documentation tools
lint: code linting, fixing, and type checking
test: unit and integration tests
## 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`