Files

Build and Test / build (pull_request) Has been cancelled

Details

docs: initialize mdBook structure with stub pages and deployment workflow

- Add docs/book.toml with coal theme, repo link, and custom CSS
- Add docs/src/SUMMARY.md with navigation structure
- Create 16 content pages across guide/, architecture/, development/, reference/
- Add docs/theme/kindred.css with minimal sidebar overrides
- Add .gitea/workflows/docs.yml for auto-deploy on push to main
- Add docs/book/ to .gitignore

Pages are populated with real content from the codebase where possible.
Remaining pages have TODO markers for future content.

2026-02-09 07:59:01 -06:00

1.1 KiB

Raw Blame History

Installation

Prebuilt packages

Download the latest release from the releases page.

Debian / Ubuntu

sudo apt install ./kindred-create_*.deb

AppImage (any Linux)

chmod +x KindredCreate-*.AppImage
./KindredCreate-*.AppImage

The AppImage is a self-contained bundle using squashfs with zstd compression. No installation required.

macOS

macOS builds are planned but not yet available in CI. Build from source for now.

Windows

Windows builds are planned but not yet available in CI. Build from source for now.

Verifying your installation

Launch Kindred Create and check the console output (View > Report View) for:

Create: Loaded ztools Init.py
Create: Loaded silo Init.py
Create module initialized

This confirms the bootstrap module loaded both workbenches. If Silo is not configured, you will see a settings prompt on first launch.

Uninstalling

Debian/Ubuntu:

sudo apt remove kindred-create

AppImage: Delete the .AppImage file. No system files are modified.

1.1 KiB Raw Blame History