aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2011-08-26 22:20:49 +0200
committerJakob Odersky <jodersky@gmail.com>2011-08-26 22:20:49 +0200
commit02aae11b5143add4e0f91673bf371d1cb37078ee (patch)
tree423e054f460b9dd92156cb4974a4b3955811b66e
parent2750bc0277c3d929603daceee2e8a1e88368a306 (diff)
downloadsims2-02aae11b5143add4e0f91673bf371d1cb37078ee.tar.gz
sims2-02aae11b5143add4e0f91673bf371d1cb37078ee.tar.bz2
sims2-02aae11b5143add4e0f91673bf371d1cb37078ee.zip
Completed readme.
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
index e69de29..951c8a6 100644
--- a/README
+++ b/README
@@ -0,0 +1,25 @@
+SiMS2 is a 2D mechanics simulation library written in Scala.
+
+
+It is a complete re-write of SiMS, hosted at http://sourceforge.net/projects/simplemechanics/.
+
+=Features=
+ * 2D rigid body simulation
+ * standalone collision detection (can be used without SiMS2 physics library)
+ * constraint simulation
+ * extensible architecture
+
+----
+
+SiMS2 is currently in development and no stable release is available.
+However, there exists a graphical testbed using the Processing.org library. To run it:
+ # Checkout the latest project revision.
+ # If you don't already have it, install sbt (http://code.google.com/p/simple-build-tool/).
+ # In the sbt command prompt, run the command "demo".
+ # Navigation in the graphical demo:
+ * pause/unpause: 'space'
+ * single step: 'enter'
+ * previous/next test: '<'/'>'
+ * zoom in/out: 'page up'/'page down';
+ * move: arrow keys;
+