DaleDunn / BOLTS

BOLTS is a open library of technical specifications
GNU General Public License v3.0
2 stars 0 forks source link

BOLTS

BOLTS is an Open Library for Technical Specifications.

This repository contains all the tools and data that are required to build the different distributions and the website. You only need to get the content of this repository if you want to contribute content to BOLTS or want to develop the tools that are used to manage it.

If you just want to use BOLTS, then you should get the BOLTS distribution for the CAD tool of your choice from the download section <http://jreinhardt.github.io/BOLTS/downloads.html> of the webpage instead. Instructions on how to use the distributions can be found in the documentation section <http://jreinhardt.github.io/BOLTS/doc/index.html>.

The webpage contains a lot of general infos, an overview over the specifications <http://jreinhardt.github.io/BOLTS/html/index.html> of all parts contained in BOLTS and quite a bit of documentation <http://jreinhardt.github.io/BOLTS/doc/index.html>. So if you have more questions, the chances to find answers on the webpage

http://jreinhardt.github.io/BOLTS/index.html

are much higher than to find them here.

Use

You should check out the documentation <http://jreinhardt.github.io/BOLTS/doc/index.html> on the webpage <http://jreinhardt.github.io/BOLTS/index.html> for more informations on how to get and use BOLTS.

Dependencies for use

To use BOLTS for OpenSCAD

is required.

To use BOLTS for FreeCAD

is required.

Development

The git version of BOLTS uses submodules, so after cloning, you will need to run

git submodule init git submodule update

to get the correct states for the submodules. For more informations about submodules, see http://git-scm.com/book/en/Git-Tools-Submodules.

Dependencies for development

In any case you should have

installed.

Depending on the target system you want to develop for additional dependencies are required.

For BOLTS for OpenSCAD:

For BOLTS for FreeCAD

For BOLTS for SolidWorks

To generate the HTML pages for the webpage

To run the bolts.py utility script (for development)