mirror of
https://github.com/aclist/dztui.git
synced 2026-08-30 03:37:00 +02:00
Compare commits
2 Commits
8edb38f175
...
c080847efc
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c080847efc | ||
|
|
40e244e05a |
@ -1,18 +1,30 @@
|
|||||||
# TODO: link to here from sphinx docs
|
# TODO: link to here from sphinx docs
|
||||||
|
|
||||||
# Installing dev dependencies
|
## Installing from source
|
||||||
uv pip install -e .[dev]
|
|
||||||
|
|
||||||
# Setting up precommit hooks
|
### Fetch submodules
|
||||||
pre-commit install
|
|
||||||
|
|
||||||
# Fetching submodules
|
|
||||||
git submodule update --recursive --init
|
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
|
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`
|
1. Set up the build target: `rustup target add x86_64-unknown-linux-musl`
|
||||||
2. Run `python3 scripts/release.py`
|
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`
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user