Files

Build and Test / build (pull_request) Successful in 24m46s

Details

docs: comprehensive documentation refresh — remove stale references, add missing content

Root documentation:
- README.md: add Datums description, update addon load order and SDK references,
  fix project structure tree, update issue reporting guidance
- CONTRIBUTING.md: update submodule table (remove ztools, add gears/datums/solver),
  fix QSS guidance (single canonical source, not three copies)
- docs/ARCHITECTURE.md: update bootstrap flow (5 addons, split deferred timers
  between Create core and Silo addon), update load order and source layout
- docs/COMPONENTS.md: add Datums and Solver sections, update Gears description,
  fix Silo origin registration reference
- docs/KNOWN_ISSUES.md: create missing file referenced by CLAUDE.md and CONTRIBUTING.md
- docs/INTEGRATION_PLAN.md: update layer 5 diagram, fix load order references,
  update Phase 6 install rules, fix Layer 2/3/5 descriptions
- docs/OVERVIEW.md: add datums submodule entry
- docs/UPSTREAM.md: update Phase 1 directory table and Phase 4 submodule list

mdBook documentation (docs/src/):
- SUMMARY.md: replace dead architecture/ links with existing reference pages,
  remove deleted silo-server files, add new silo-server pages
- introduction.md: rewrite — replace ztools with current addons (Silo, Gears,
  Datums, KCSDK), update version to v0.1.5/FreeCAD 1.2.0
- guide/getting-started.md: update first-run addon list
- guide/installation.md: update verification console output
- guide/workbenches.md: rewrite — replace ztools with Gears, Datums, Solver
- guide/building.md: update submodule table, fix error message guidance
- development/contributing.md: fix scope example and issue reporting
- development/repo-structure.md: rewrite — add SDK, datums, gears, solver,
  reference/ folder; update submodule and key files tables
- development/writing-an-addon.md: fix priority range table
- reference/create-module-bootstrap.md: rewrite — reflect addon_loader system,
  split deferred timers between Create core and Silo addon
- reference/datum-creator.md: update from ZTools to datums addon paths and naming
- reference/glossary.md: add KCSDK entry, update FreeCAD version, remove ztools
  entry, update repository URLs table

2026-03-03 13:52:53 -06:00

1.2 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:

addon_loader: loading sdk (priority 0)
addon_loader: loading solver (priority 10)
addon_loader: loading gears (priority 40)
addon_loader: loading datums (priority 45)
addon_loader: loading silo (priority 60)

This confirms the bootstrap module loaded all addons. 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.2 KiB Raw Blame History