GitBuilding is an open source program for writing hardware assembly instructions.
Keeping documentation up to date while you are prototyping is essential if working in a large or distributed team. But keeping complex documentation and Bills of Materials in sync can be difficult. GitBuilding automates many of these tasks so you can stop worrying about documentation and get back to building something awesome.
Stop worrying, GitBuilding!
GitBuilding allows you to:
- Write assembly instructions as you are prototyping, in Markdown, using a two-paned editor that previews the final output.
- Tag links in your text with meta-data (part specs, descriptions, quantities); marking them as pre-requisite assembly steps or parts you need to purchase.
- You can also efficiently bulk-define part meta-data using separate part libraries.
- Automatically generate independent documentation and final bills of materials for multiple variations of your project.
- Generate previews of 3D files, and automatically zip only the production files that are needed for a specific variation.
- Export your documentation in Markdown, HTML, or PDF, and your final BOM as a CSV.
- Keep track of your evolving documentation within any version control system that supports plain text (such as Git).
Keep control of your documentation
GitBuilding uses Markdown with some additional syntax. We call this BuildUp. Despite introducing a new format you never risk lock-in. GitBuilding is both open source, and it can export your documentation to plain Markdown. If you wish to move your documentation away from GitBuilding you can export it as plain Markdown.
GitBuilding is beginning to mature, but the syntax still may change. We are open to feedback and suggestions. If you want to get involved please visit the project on GitLab or get in contact via Gitter or using our space on the GOSH forum.
Examples of GitBuilding Documentation
- OpenFlexure Microscope (source)
- OpenFlexure Field Dissection Microscope (source)
- autohaem smear (source)
GitBuilding is used by
