summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Dale <Robert.Dale@sensus.com>2016-08-16 14:48:20 -0400
committerRobert Dale <Robert.Dale@sensus.com>2016-08-16 14:48:20 -0400
commitdaf265de14cd7a46c718a68172238c7fcddc5d3c (patch)
tree006b70ad968bc260eefc4c44b3016fa42532e053 /README.md
parent1515345e68cd83a6b19f7378890b4f415d06d200 (diff)
added to section Generating a Design
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5f622f2..fca31e8 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,24 @@ The Dactyl is a parameterized, split-hand, concave, columnar, ergonomic keyboard
## Assembly
### Generating a Design
-TODO
+
+**Setting up the Clojure environment**
+* (Download and install the Clojure runtime)[https://clojure.org]
+* (Download and install the Leiningen project manager)[http://leiningen.org/]
+* (Download and install OpenSCAD)[http://www.openscad.org/]
+
+**Generating the design**
+* Run `lein repl`
+* Load the file `(load-file "src/dactyl_keyboard/dactyl.clj")`
+* This will regenerate the `things/*.scad` files
+* Use OpenSCAD to open a `.scad` file.
+* Make changes to design, repeat `load-file`, OpenSCAD will watch for changes and rerender.
+* When done, use OpenSCAD to export STL files
+
+**Tips**
+* Some other ways to evaluate the clojure design file - http://stackoverflow.com/a/28213489
+* Example designing with clojure http://adereth.github.io/blog/2014/04/09/3d-printing-with-clojure/
+
### Printing
Pregenerated STL files are available in the [things/](things/) directory.