MJ> Got it. How do we annotate more clearly - some users won't be able to find
MJ> this. Can you put some notes about which folders to go to on Github?
I am not in position to do much more this morning but I can copy this
text to README.md later today (do you think people can find that file
easily enough?):
This project directory is organized hierarchically. There is a
subdirectory for each part, using a name that include their index
number in the master index. For example, i88-rear-plate is for index
number 88
Within each part directory there is a subdirectory for the master
CAD files (the preferred format for editing updates into the design),
identified by the CAD tool used, for example master-alibre. Usually
you will need have a specific CAD program installed on your computer
in order to make use of these files.
Also within the part directory there is an 'exports' subdirectory.
These are outputs from the CAD program intended for (1) human viewing,
and/or (2) passing to later stages of the manufacturing toolchain. For
example, you can expect to find a pdf working drawing here.
Finally, the 'reference' subdirectory is a catch-all for information
that is not a direct part of the toolchain.
There are two active branches. The 'master' branch is intended for
finished documentation. The 'edge' branch is for revisions in progress
and should not, in general, be used for fabrication.
chuck-h
commented
11 years ago
MJ> Got it. How do we annotate more clearly - some users won't be able to find MJ> this. Can you put some notes about which folders to go to on Github?
I am not in position to do much more this morning but I can copy this text to README.md later today (do you think people can find that file easily enough?): This project directory is organized hierarchically. There is a subdirectory for each part, using a name that include their index number in the master index. For example, i88-rear-plate is for index number 88 Within each part directory there is a subdirectory for the master CAD files (the preferred format for editing updates into the design), identified by the CAD tool used, for example master-alibre. Usually you will need have a specific CAD program installed on your computer in order to make use of these files. Also within the part directory there is an 'exports' subdirectory. These are outputs from the CAD program intended for (1) human viewing, and/or (2) passing to later stages of the manufacturing toolchain. For example, you can expect to find a pdf working drawing here. Finally, the 'reference' subdirectory is a catch-all for information that is not a direct part of the toolchain. There are two active branches. The 'master' branch is intended for finished documentation. The 'edge' branch is for revisions in progress and should not, in general, be used for fabrication.