X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;fp=README.md;h=ba629470d83f576525129b682009bc7b4e9af644;hb=533f6eec9dc6d17a5cb0fb8f77d175f5d4392b42;hp=0000000000000000000000000000000000000000;hpb=181b3d6a36a6cb74e355727c71b60f0898191468;p=ekitaihs.git

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba62947
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# 液体「ekitai」
+
+ekitai.hs is a terminal fluid simulator written in haskell. it is a submission to RUHacks 2021. the simulation algorithm is quite simple, it's a similar particle based one that games like 'the sandbox' and 'terraria' use.
+
+## Usage
+ekitai reads a text file with the desired simulation. samples can be found in the samples/ directory of this repo. valid characters for the simulation are as follows
+- `#`: wall block
+- `~`: water
+- `@`: pump, spawns water below it
+- `O`: drain, removes water around it
+
+## Installation
+### Deb based
+### Arch based
+### Build from Source
+as this project does not use stack or cabal or anything, haskell dependencies will have to be installed separately. this is a bit difficult to document since the packages varies by distro, for arch at least, the following are required
+- ghc
+- ghc-libs
+- haskell-vector
+- haskell-brick
+
+and then simply run `sudo make install`.
+
+## FAQ
+**why ekitai?**
+
+ekitai is fluid in japanese. since naming your projects in a different language is apparently cool.
+
+**why not in c?**
+
+c would have probably been one of the best choices to do this project in, but i wanted to add a bit of challenge by using a language that i didn't know.
+