readme

.gitignore

@@ -1,3 +1,7 @@
+
+.obsidian/*
+.vscode/*
+
 # ---> Rust
 # Generated by Cargo
 # will have compiled files and executables

README.md

@@ -1,3 +1,13 @@
-# egui-circles
 
-Immediate Mode GUI app, with basic simulation of a perfectly elastic collision between balls
+Immediate Mode GUI app with naive visualisation for elastic balls collisions.
+
+# Build & run 
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # install rust
+cargo run --package=egui-circles                               # build & run
+```
+
+# HowTo
+
+Detailed information on how to use [egui](https://github.com/emilk/egui) rust library can found [here](https://egui.info/).