diff options
author | Oxbian <oxbian@mailbox.org> | 2025-02-21 19:17:35 -0500 |
---|---|---|
committer | Oxbian <oxbian@mailbox.org> | 2025-02-21 19:17:35 -0500 |
commit | 2c03f0c29f582e7c8b2bd99c1ffa0b1ca7c96eff (patch) | |
tree | 0511c13b4fb7d8ce2506def2afa156360e8b230a | |
parent | bc53ad567b82ca354f2b8caf30f242717a5f46a6 (diff) | |
download | NAI-2c03f0c29f582e7c8b2bd99c1ffa0b1ca7c96eff.tar.gz NAI-2c03f0c29f582e7c8b2bd99c1ffa0b1ca7c96eff.zip |
feat: improving README
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | README.md | 33 | ||||
-rw-r--r-- | screenshots/ui.png | bin | 0 -> 10567 bytes |
3 files changed, 32 insertions, 2 deletions
@@ -1 +1,2 @@ /target +debug.txt @@ -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 diff --git a/screenshots/ui.png b/screenshots/ui.png Binary files differnew file mode 100644 index 0000000..b854a89 --- /dev/null +++ b/screenshots/ui.png |