GitBuilding: A tool for writing build instructions

Resources
1

We have been working on a free and open source tool for writing build instructions for hardware projects called GitBuilding.

This was borne out of documenting our OSHW 3D-printable microscope and precision positioning system. It’s essentially a static site generator, so it’s a good fit if you want to host documentation on GitHub or GitLab pages. It does provide a PDF output as well (though this is still somewhat experimental).

It’s early days, so to try it out you need to be comfortable with command-line tools and using Python’s pip installer. We are also working on the structure and syntax and may still change things around. We are however close to migrating our own documentation to it, so will be as annoyed as you if we need to make breaking changes.

At this stage we’d love for people to try it out, gather feedback and better understand other people’s use-cases for something like this.

6 Likes
2

It never ceases to amaze me how busy you keep yourself, @kaspar!

You’ve got your hands in a lot of projects. I’m humbled to see you contribute to so many different efforts.

1 Like
3

Thanks @nrc.reilly, thats kind of you to say. I think the trick is to start lots of things and never finish anything. :laughing: GitBuilding is primarily the work of my colleague Julian Stirling though.

1 Like
4

You’re that much farther ahead of me, then. :+1:

1 Like