History

Jeremy Wright 787f2033d3 ci/woodpecker/push/woodpecker Pipeline was successful Details Added a jpg of the stereoscope gallery image to try to decrease size		2023-08-30 09:03:05 -04:00
..
assets	Added slots for apertures	2023-07-06 21:00:00 -04:00
images	Added a jpg of the stereoscope gallery image to try to decrease size	2023-08-30 09:03:05 -04:00
manufacturing_files	Added lenses and changed the center stripe of the shim apertures	2023-08-16 11:06:12 -04:00
.gitignore	Started GitBuilding documentation	2023-06-09 16:39:57 -04:00
Parts.yaml	Getitng the documentation caught up with the current state of the stereoscope	2023-07-05 11:45:15 -04:00
README.md	Started GitBuilding documentation	2023-06-09 16:39:57 -04:00
Tools.yaml	Fixed the 2.5mm hex wrench not having a global supplier	2023-06-23 16:16:36 -04:00
acknowledgments.md	Updated shim apertures and acknowledgements	2023-08-07 15:33:02 -04:00
assembly.md	Attempting to finish assembly instructions for current state of design	2023-07-05 15:17:48 -04:00
buildconf.yaml	Updated buildconf YAML file	2023-07-14 12:32:50 -04:00
index.md	Added acknowledgement docs page and started stereo-shim assembly	2023-06-15 21:35:14 -04:00
mirror_cutting.md	Added tools for cutting glass and added safety warning	2023-06-20 14:34:52 -04:00
printing.md	Separated global parameters out into a separate file	2023-07-21 15:22:31 -04:00
procurement.md	Finished a rough draft of all documentation sections except assembly	2023-06-14 10:24:55 -04:00
widget.md	Started GitBuilding documentation	2023-06-09 16:39:57 -04:00

README.md

This project is documented with GitBuilding

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.