openscad/Mendel90
1
0
Fork 0
mirror of https://github.com/nophead/Mendel90.git synced 2025-08-05 12:57:24 +02:00
Code Issues Releases Wiki Activity

improve README aesthetics

Browse Source
This commit is contained in:
Brad Pitcher
2014-02-07 15:26:52 -08:00
parent 718e8ebd4d
commit eaff3ec3f2
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.txt → README.md
View File

@@ -1,18 +1,20 @@
Limitations Limitations
----------- ===========
Currently only supports mendel and sturdy machine variants, the huxley version needs more work. Currently only supports mendel and sturdy machine variants, the huxley version needs more work.
Use Use
--- ===
Add the directory of the OpenScad executable to your search path. OpenSCAD-2013.06 or later is required. Add the directory of the OpenScad executable to your search path. OpenSCAD-2013.06 or later is required.
To get PDF versions of the sheet drawings add InkScape to your search path. To get PDF versions of the sheet drawings add InkScape to your search path.
To make all the files for a machine run To make all the files for a machine run
```python
make_machine.py machine_name make_machine.py machine_name
```
To make just the bom, sheets or stls run bom.py, sheets.py or stls.py machine_name. To make just the bom, sheets or stls run bom.py, sheets.py or stls.py machine\_name.
machine_name can be mendel or sturdy. To make your own variant copy scad\conf\mendel_config.scad or scad\conf\sturdy_config.scad to yourname_config.scad. Then run make_machine yourname. machine\_name can be mendel or sturdy. To make your own variant copy scad\conf\mendel\_config.scad or scad\conf\sturdy\_config.scad to yourname\_config.scad. Then run `make_machine yourname`.
To view the model of the whole machine, open scad\main.scad. It will take several minutes to render (about about 8 minutes on my computer) but after that you can pan and zoom it at reasonable speed and changes takes less time to render. (Note: main.scad will only render correctly if conf\machine.scad exists, which is created by the make_machine.py script.) To view the model of the whole machine, open scad\main.scad. It will take several minutes to render (about about 8 minutes on my computer) but after that you can pan and zoom it at reasonable speed and changes takes less time to render. (Note: main.scad will only render correctly if conf\machine.scad exists, which is created by the make_machine.py script.)
@@ -21,17 +23,17 @@ To view a sub-assembly, open the individual scad files. Set the exploded flag in
To get blender renders of all the parts put blender in your search path and run render.py machine_name. To get blender renders of all the parts put blender in your search path and run render.py machine_name.
Credits Credits
------- =======
Fan model based on http://www.thingiverse.com/thing:8063 by MiseryBot, CC license. Fan model based on [this model](http://www.thingiverse.com/thing:8063) by MiseryBot, CC license.
Sanguinololu model http://www.thingiverse.com/thing:18606 by ax_the_b, CC license. [Sanguinololu model](http://www.thingiverse.com/thing:18606) by ax\_the\_b, CC license.
Spring taken from openscad example 20 Spring taken from openscad example 20
x-end.scad and wade.scad use some elements of the Prusa ones by Josef Prusa, GPL license. x-end.scad and wade.scad use some elements of the Prusa ones by Josef Prusa, GPL license.
z_couplings originally based on http://www.thingiverse.com/thing:7153 by Griffin_Nicoll, GPL license. z_couplings originally based on [this model](http://www.thingiverse.com/thing:7153) by Griffin_Nicoll, GPL license.
Bearing holders originally based on http://www.thingiverse.com/thing:7755 by Jolijar, CC license. Bearing holders originally based on [this model](http://www.thingiverse.com/thing:7755) by Jolijar, CC license.
InkCL.py based on code from http://kaioa.com/node/42 InkCL.py based on [this code](http://kaioa.com/node/42)