aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2011-08-26 22:27:04 +0200
committerJakob Odersky <jodersky@gmail.com>2011-08-26 22:27:04 +0200
commit14aac7e7aabda1dd5a10c8c5f0d69776596e191e (patch)
tree4e528a2ee31ff92841124cb4acad47e8bff96ae0 /README.md
parent02aae11b5143add4e0f91673bf371d1cb37078ee (diff)
downloadsims2-14aac7e7aabda1dd5a10c8c5f0d69776596e191e.tar.gz
sims2-14aac7e7aabda1dd5a10c8c5f0d69776596e191e.tar.bz2
sims2-14aac7e7aabda1dd5a10c8c5f0d69776596e191e.zip
Moved README to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..951c8a6
--- /dev/null
+++ b/README.md
@@ -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;
+