Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.32 KB

README.md

File metadata and controls

25 lines (18 loc) · 1.32 KB

This project is documented with GitBuilding

Access the Documentation

The updated documentation for this project can be accessed directly here.

What is GitBuilding

GitBuilding is an OpenSource project for documenting hardware projects with minimal effort, so you can stop writing and GitBuilding. GitBuilding is a python program that works on Windows, Linux, and MacOS. More information on the GitBuilding project, or how to install GitBuilding please see the GitBuilding website.

How do I edit the documentation?

To edit the documentation you do not need to install anything, the documentation files can be opened in a plain text editor such as Windows Notepad, Notepad++, gedit, VS Code, etc. We recommend installing GitBuilding to preview any changes to the documentation. GitBuilding also comes with a browser-based editor that has a live display of the final HTML documentation.

If you have ever used markdown you will notice that the files you are editing are markdown files. GitBuilding uses an extended markdown syntax (that we call BuildUp). This allows you to keep track of parts in the documentation. More detailed documentation is available on the GitBuilding website.