Update readme
| Author | Mitja Felicijan <mitja.felicijan@gmail.com> | 2026-02-20 14:11:29 +0100 |
| Committer | Mitja Felicijan <mitja.felicijan@gmail.com> | 2026-02-20 14:11:29 +0100 |
| Commit | 98af38c5a3e00d0843677bd044203b7a91172134 (patch) |
|
| diff --git a/Makefile b/Makefile | |||
| ... | |||
| 62 | xxd -i $< > $@ |
62 | xxd -i $< > $@ |
| 63 | 63 | ||
| 64 | corpus/%.vdb: corpus/%.txt build/context |
64 | corpus/%.vdb: corpus/%.txt build/context |
| 65 | ./context -i $< -o $@ |
65 | ./context -m qwen3 -i $< -o $@ |
| diff --git a/README.md b/README.md | |||
| ... | |||
| 14 | - Test existing small and tiny LLMs and provide some useful results on how they |
14 | - Test existing small and tiny LLMs and provide some useful results on how they |
| 15 | behave. |
15 | behave. |
| 16 | 16 | ||
| 17 | ## Getting started |
||
| 18 | |||
| 19 | 1. Build dependencies and binaries: |
||
| 20 | ```bash |
||
| 21 | make build/llama.cpp |
||
| 22 | make run/fetch-models |
||
| 23 | make build/context |
||
| 24 | make build/game |
||
| 25 | ``` |
||
| 26 | |||
| 27 | 2. Build a vector context database: |
||
| 28 | ```bash |
||
| 29 | build/corpus |
||
| 30 | ``` |
||
| 31 | |||
| 32 | 3. Run the game: |
||
| 33 | ```bash |
||
| 34 | ./game -m phi-4-mini-instruct -e qwen3 |
||
| 35 | ``` |
||
| 36 | |||
| 17 | ## Building |
37 | ## Building |
| 18 | 38 | ||
| 19 | ### Prerequisites |
39 | ### Prerequisites |
| ... | |||
| 52 | different model. |
72 | different model. |
| 53 | 73 | ||
| 54 | ```bash |
74 | ```bash |
| 55 | ./context -m qwen3 -i corpus/lotr.txt -o corpus/lotr.vdb |
75 | ./context -m qwen3 -i corpus/map1_keldor.txt -o corpus/map1_keldor.vdb |
| 56 | ``` |
76 | ``` |
| 57 | 77 | ||
| 58 | ### Run an NPC query with retrieved context |
78 | ### Run an NPC query with retrieved context |
| ... | |||
| 62 | You can pass a separate embedding model with `-e`/`--embed-model`. |
82 | You can pass a separate embedding model with `-e`/`--embed-model`. |
| 63 | 83 | ||
| 64 | ```bash |
84 | ```bash |
| 65 | ./npc -m phi-4-mini-instruct -e qwen3 -p "Who is Gandalf?" -c corpus/lotr.vdb |
85 | ./npc -m phi-4-mini-instruct -e qwen3 -p "Who is Keldor?" -c corpus/map1_keldor.vdb |
| 66 | ./npc -m qwen3 -e qwen3 -p "Who is Frodo?" -c corpus/lotr.vdb |
86 | ./npc -m qwen3 -e qwen3 -p "What does Keldor believe about the marsh lights?" -c corpus/map1_keldor.vdb |
| 67 | ``` |
87 | ``` |
| 68 | 88 | ||
| 69 | ### Run the game |
89 | ### Run the game |
| ... | |||