Browse files

Update documentation

  • Loading branch information...
bgamari committed Dec 16, 2011
1 parent d4823ab commit b4486e421955fe158a462e8ddbe29c6752caaf82
Showing with 47 additions and 15 deletions.
  1. +47 −15 README.mkd
@@ -1,26 +1,58 @@
# GGen
`GGen` is a G-code generator targetted at 3D additive printers (e.g.
-[RepRap]( It was developed out of frustration with the
-dominant package in this design space, [Skeinforge](
-Written in Haskell, GGen strives to be a clean, fast, and easily verifiable
-alternative to Skeinforge.
+[RepRap]( While the dominant package in this design
+space, Skeinforge, does an admirable job of turning models into G-code, its
+usability and performance leave something to be desired. GGen seeks to bring the power of the cutting-edge Haskell programming language to bear on the problem slicing. In doing so, we hope to,
-## Usage
+ * Be fast: Most models are sliced in under 10 seconds. Yes, that fast.
+ * Be efficient: Generate G-code to drive the printer efficiently
+ * Be easy to use: A simple configuration format allows beginners to get their printer up quickly
+ * Be flexible: GGen provides a library interface for those who need more flexibility
+ * Be hackable: Abstraction enables clear reasoning over difficult problems
+ while type safety helps guarantee correctness
+## Installation
+First, you will need the
+[Haskell Platform]( installed. If you are
+running Ubuntu, this is quite simple,
+ $ sudo apt-get install ghc libghc-gtk-dev libghc-cairo-dev cabal-install
+If not, refer to the [Haskell Platform](
+download page for your platform.
-While GGen is still in the early stages of development, it can produce
-reasonable G code albeit with some limitations. That being said, it lacks many
-of the more advanced features of Skeinforge (e.g. raft generation, etc.).
+Once Haskell has been installed, installation is a matter of grabbing and building the source,
+ $ git clone git://
+ $ cd GGen
+ $ cabal install
+This should grab any dependencies, build, and install GGen.
+## Usage
-At the moment on the STL input format is supported. To produce G-code from an
-STL model (both binary and , one must first compile the package,
+While GGen is still in the early stages of development, it can produce very
+reasonable G code. That being said, it lacks many of the more advanced features
+of Skeinforge (e.g. raft generation, skirts, etc.).
- $ ghc -O Main.hs
+GGen can be configured in two ways. Most users will want to use the simple
+configuration option.
-Now simply passing an STL model name on the command line will produce a G code
-file along with an SVG image of the toolpath for each produced slice,
+At the moment only the STL input format is supported. To produce G-code from an
+STL model (both binary and ASCII)
- $ ./Main test.stl
+## Alternatives
-Configuration parameters are currently hard-coded in various source files.
+ * [Skeinforge](
+ The dominant package in this design space. Quite comprehensive and
+ reasonably robust but difficult to configure and rather slow.
+ * [SFACT](
+ A variant of Skeinforge
+ * [Slic3r](
+ A clean and fast slicer written in Perl seeking to fulfil many of the same
+ goals as GGen.
+ * [SuperSkein](
+ * [RepRap Host](

0 comments on commit b4486e4

Please sign in to comment.