For documenting hardware projects with minimal effort,so you can stop writing and GitBuilding.
GitBuilding is a program for documenting hardware designs. It's primary focus is on high-quality, up-to-date assembly instructions. GitBuilding gives you the freedom to write instructions in the form and structure that you want using markdown. It uses extra metadata to track component usage, and generate bills of materials. Independent, clear, and consistent documentation can be generated for variations of the same design without specifying the same information multiple times.
In GitBuilding you are able to:
To install (for Python 3.7+)
pip install gitbuilding[gui]
If you don't want to use the stand-alone GUI, you can avoid installing PyQT with
pip install gitbuilding[gui]
More details are available on the website.
To run the stand-alone GitBuilding GUI run:
gitbuilding-gui
or to view the same interface in a browser run
gitbuilding webapp
then navigate to localhost:6178 in your browser.
From this GUI you can open or create new projects. The GUI will launch a live editor in a browser for previewing and editing your documentation.
More details are available on the website.
You are welcome to ask for help in the issue tracker. You can also talk to us on our area of the GOSH forum or on Gitter (though we may not be too responsive due to Matrix notification issues!)
If you wish to contribute to development of GitBuilding you can clone the project from GitLab. You will need to install the python package in development mode and build the javascript editor from source.
To do so please see the contribution page and the developer installation instructions.
The syntax for documentation is in a format we call BuildUp. More details are available on the website.
FAQs
For documenting hardware projects with minimal effort,so you can stop writing and GitBuilding.
We found that gitbuilding demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.