about summary refs log tree commit diff
diff options
context:
space:
mode:
authorlukasepple <git@lukasepple.de>2015-11-28 18:55:47 +0100
committerlukasepple <git@lukasepple.de>2015-11-28 18:55:47 +0100
commit9df187315539803efbabb66de2c205dfe38b4010 (patch)
treef5b9c25da2e3eb3801640d90e01575d726ca5dac
parent0392dd880428e4b7c1c0abdd7bfbfbff4ae181ce (diff)
Added README
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23b474d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# grav1ty
+
+grav1ty will probably be a two dimensional space game! It will be awesome!
+
+grav1ty is written in Haskell using [frpnow][frpnow-paper] and [gloss][gloss].
+Physics computations are mainly powered by Edward Kmett's [linear][linear].
+
+Currently it only does gravity computations in a FRP-y way but it will
+definately evolve!
+
+## Things left to do
+
+* collisions
+* manual acceleration / spaceship controls
+* Nice models for object
+* random universe generations
+* moving viewport?
+
+# Building
+
+Like most haskell projects grav1ty can be build using cabal, I also provided an
+`shell.nix` for dependency management.
+
+[frpnow-paper]: http://www.cse.chalmers.se/~atze/papers/prprfrp.pdf
+[gloss]: http://hackage.haskell.org/package/gloss
+[linear]: https://hackage.haskell.org/package/linear
+[naudiz]: https://github.com/KiNaudiz