diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 31 insertions, 2 deletions
@@ -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 + + ## 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 |