Merge pull request #9 from donbright/master

clarify that there are no wildcards in OpenSCAD use/include statements
This commit is contained in:
Elmo 2012-08-07 06:50:07 -07:00
commit 8930770b3a

View file

@ -10,13 +10,15 @@ See http://creativecommons.org/licenses/LGPL/2.1/ or the included file, lgpl-2.1
## Usage ## ## Usage ##
You can import these files in your scripts with `use <MCAD/*.scad>`, but some You can import these files in your scripts with `use <MCAD/filename.scad>`,
files include useful constants which will be available with `include <MCAD/*.scad>`, where 'filename' is one of the files listed below like 'motors' or
which should be safe to use on all included files (ie. no top level code should 'servos'. Some files include useful constants which will be available
create geometry). (There is a bug/feature that prevents including constants from with `include <MCAD/filename.scad>`, which should be safe to use on all
files that "include" other files - see the openscad mailing list archives for more included files (ie. no top level code should create geometry). (There is
details. Since the maintainers aren't very responsive, may have to work around this a bug/feature that prevents including constants from files that
somehow) "include" other files - see the openscad mailing list archives for more
details. Since the maintainers aren't very responsive, may have to work
around this somehow)
If you host your project in git, you can do `git submodule add URL PATH` in your If you host your project in git, you can do `git submodule add URL PATH` in your
repo to import this library as a git submodule for easy usage. Then you need to do repo to import this library as a git submodule for easy usage. Then you need to do