Add readme, .gitignore

cibomahto · Apr 9, 2012 · 222baf2 · 222baf2
1 parent 4a49c9c
commit 222baf2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+*.pyc
diff --git a/readme.markdown b/readme.markdown
@@ -0,0 +1,15 @@
+# s3g
+
+S3g is an attempt at implementing the MakerBot serial protocol in python. The main goal is to control some plotter devices. If it proves useful, then certainly something else could be done with it.
+
+## Usage
+
+For now, just some unit tests:
+
+    python s3g_test.py
+
+Once it can pass these, then some comms handler, etc. It's only going to support a blocking interface.
+
+## Reference
+
+See the [RepRap Generation 3 (s3g) Protocol Specification](https://docs.google.com/a/makerbot.com/document/d/1oq-oEogcRxJ91ex4_cJLs8bXPmWoTKJRNPz9Amh0Hb4/edit#heading=h.054a1e7d67e9)