add readme

README.md

+Hej Ingemar!
+
+Projektet ligger i mappen `diorama`. För att köra koden:
+
+- Ladda ner Rust (t.ex. via rustup: https://rustup.rs/, stable fungerar utmärkt)
+- Ställ dig i mappen `diorama`
+- Kör `cargo run --release`
+
+Själva projektkoden ligger huvudsakligen i `diorama/src`. Namnen är ganska
+självförklarande, men det finns några filer som inte används i slutändan (t.ex.
+`stylized_nature`, några andra modeller vi hittade).
+
+`finite-volume-methods` innehåller koden för vattensimuleringen som används i
+projektet (filen `finite-volume-methods/src/water.rs`) och några
+exempelvisualiseringar som vi byggde upp under utvecklingen.
+
+För att köra dom olika visualiseringarna:
+
+- Ställ dig i mappen `finite-volume-methods`
+- Kör `cargo run --release --bin [VARIANT]` där [VARIANT] är någon av `1d`,
+  `2d`, `2d-v2`, `3d` och `3d-rt`.
+
+Sist har vi Rust-varianten av MicroGLUT i mappen `microglut`. Den innehåller
+abstraktioner för texturer, modeller och FBO. Det finns dessutom en serie
+exempel i `microglut/examples` som är portade från demosidan. Dessa visar hur
+Rust-biblioteket kan användas från Rust. Koden är skriven som C++-koden så
+långt det går.
+
+För att köra ett exempel:
+
+- Ställ dig i mappen `microglut`
+- Kör `cargo run --example [EXAMPLE]` där [EXAMPEL] är namnet på något av
+  exemplena, t.ex. `16-simple-07-textured-quad-inline` eller
+  `heavy-metal-teapot`.