Documentation
zslice documentation
For people who slice with zslice
- Getting started: the user guide of the apps, from your first print to a print farm.
- The command line: build zslice, slice a part, check it, and measure the speed.
- Settings reference: each setting, its unit, and its default.
- Profiles: machine, filament, and project files, with inheritance and overrides.
- The macOS app: where the Mac app differs: the keys, the drawer, printers, and the Keychain.
- Problems and errors: what each error means and what to do.
For developers who use the library
- Overview: the objects, the memory, the threads, and the errors.
- Zig API
- C API
- JavaScript and WebAssembly
The app
- The app: the core and the native shells, and the contract between them.
- Linux (GTK4)
- Web
For developers who change or extend zslice
- How a slicer works: the stages from mesh to G-code.
- Architecture: the modules, the data types, the memory model, and the threads.
- Settings for some layers: which settings can change per layer, and which code reads them.
- Arachne walls: walls with a variable line width, ported from CuraEngine.
- Contributing: the rules, the tests, and step-by-step guides to add a setting, a feature, or an infill pattern.
- Code quality: the plan to make the code clearer, ranked by value.
- The macOS app: the SwiftUI shell, its build, and the Metal renderer of the 3D view.
Documentation
The site at https://zslice.beetlebug.org/docs.html comes from these Markdown files. docs/build.py writes the pages into docs/, with one folder for each page. It needs only Python 3.
python3 docs/build.py
Run it after a change to a Markdown file, and commit the pages with the change. At the end, the script checks each link of the site. It stops with an error for a link to a file or an anchor that does not exist. A push to master that changes docs/ publishes the site (.github/workflows/pages.yml).
To add a page, add its Markdown file to SOURCES in docs/build.py. The script stops with an error for a Markdown file in docs/ that has no page.