Home

Jump to bottom

Jean-Luc Thiffeault edited this page Apr 25, 2026 · 8 revisions

braidlab wiki

braidlab workflow: how the repository is structured; Git usage and tips.

Main in-repo references:

devel/CI-WORKFLOW.md: CI/release runbook.
devel/RELEASE-CONFIG.md: pinned values and override knobs.
.github/workflows/build-braidlab-packages.yml: CI implementation.

CI here stands for "Continuous Integration", where GitHub Actions automatically build packages for Linux, Windows, and macOS.

Other useful markdown files in the repository:

README.md: project overview and usage basics.
CHANGELOG.md: release history and notable changes.
devel/STYLE.md: coding style and version-control conventions.
devel/PORTABILITY.md: GMP portability notes and packaging rationale.
devel/UNDOCUMENTED.md: methods/features not yet covered in the guide.
devel/MATLAB_CLASSES_HELP.md: notes on MATLAB namespace/class folder layout.
extern/README.md: overview of bundled external dependencies.
extern/cbraid/README.md: cbraid submodule notes.
extern/trains/README.md: trains library notes.