From 2c03f0c29f582e7c8b2bd99c1ffa0b1ca7c96eff Mon Sep 17 00:00:00 2001
From: Oxbian <oxbian@mailbox.org>
Date: Fri, 21 Feb 2025 19:17:35 -0500
Subject: feat: improving README

---
 .gitignore         |   1 +
 README.md          |  33 +++++++++++++++++++++++++++++++--
 screenshots/ui.png | Bin 0 -> 10567 bytes
 3 files changed, 32 insertions(+), 2 deletions(-)
 create mode 100644 screenshots/ui.png

diff --git a/.gitignore b/.gitignore
index ea8c4bf..13d3555 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
 /target
+debug.txt
diff --git a/README.md b/README.md
index e314766..ad694f9 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,37 @@
 ---
 
 Néo AI, a personnal assistant using LLM.
+A TUI interface for local llama.cpp LLM, in the future more functionnality will
+be added to this AI.
+
+## Usage
+
+### Dependencies
+
+This project is written in Rust, so you will need `rustc` and `cargo`.  
+Moreover, you will need a LLM API, currently only works with local 
+[llama.cpp](https://github.com/ggml-org/llama.cpp) API. 
+  
+### Building & Running
+
+To build and run this project you will need to install all the dependencies used:
+  
+```bash
+cargo install
+```
+  
+Once that is done, just 
+```bash
+cargo run
+``` 
+and there you go !
+
+## Screenshots
+
+![Screenshot of the ui](screenshots/ui.png)
 
 ## TODO
 
-- Gérer la sortie de l'interface, async...
-- Interface gauche <-> droite selon si c'est un bot ou un user
+- Color change if it's an user or the LLM
+- Async request to the LLM API
+- Start the real fun
diff --git a/screenshots/ui.png b/screenshots/ui.png
new file mode 100644
index 0000000..b854a89
Binary files /dev/null and b/screenshots/ui.png differ
-- 
cgit v1.2.3