djsundog/NopSCADlib
1
0
Fork 0
mirror of https://github.com/DJSundog/NopSCADlib.git synced 2025-02-19 17:13:45 -05:00
Code Issues Projects Releases Wiki Activity

Fixed code block to work on local markdown.

Browse Source
This commit is contained in:
Chris Palmer 2019-06-12 12:21:42 +01:00
parent 0126245012
commit 18533d8d8b
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/usage.md
View File

@ -15,6 +15,7 @@ The following Python modules are used and can be installed with pip:
``` ```
pip install colorama pip install colorama
pip install codespell pip install codespell
pip install markdown
``` ```
## Installation ## Installation
@ -51,24 +52,20 @@ Each project has its own directory and that is used to derive the project's name
assembly. assembly.
A skeleton project looks like this: - A skeleton project looks like this: -
//! Project description in Markdown format before the first include.
include <NopSCADlib/lib.scad>
```
//! Project description in Markdown format before the first include.
include <NopSCADlib/lib.scad>
...
//! Assembly instructions in Markdown format in front of each module that makes an assembly.
module main_assembly()
assembly("main") {
... ...
}
if($preview) //! Assembly instructions in Markdown format in front of each module that makes an assembly.
module main_assembly()
assembly("main") {
...
}
if($preview)
main_assembly(); main_assembly();
```
Other scad files can be added in the scad directory and included or used as required. Other scad files can be added in the scad directory and included or used as required.
* Subassemblies can be added in the same format as ```main_assembly()```, i.e. a module called ```something_assembly()```, taking no parameters and calling ```assembly("something")``` with * Subassemblies can be added in the same format as ```main_assembly()```, i.e. a module called ```something_assembly()```, taking no parameters and calling ```assembly("something")``` with