From 7f387cbaa0aca2e2ab72b1345e028ec0b84ee57e Mon Sep 17 00:00:00 2001
From: djmil <andriy@djmil.dev>
Date: Mon, 29 Apr 2024 14:25:45 +0200
Subject: [PATCH] readme

---
 .gitignore |  4 ++++
 README.md  | 14 ++++++++++++--
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 3ca43ae..a1a5044 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,7 @@
+
+.obsidian/*
+.vscode/*
+
 # ---> Rust
 # Generated by Cargo
 # will have compiled files and executables
diff --git a/README.md b/README.md
index 13f783f..326fbef 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
-# egui-circles
 
-Immediate Mode GUI app, with basic simulation of a perfectly elastic collision between balls
\ No newline at end of file
+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/).  
\ No newline at end of file