Skip to content

Commit 8aead97

Browse files
committed
Updated README
1 parent 90ad7f4 commit 8aead97

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
![image](https://github.com/MaggotHATE/Llama_chat/blob/main/pics/Llama_chat.PNG)
55

6+
A highly configurable chat application for running LLMs, based on [llama.cpp](https://github.com/ggerganov/llama.cpp).
7+
68
This project started from the main example of llama.cpp - the idea was to read parameters from .json files. Now it's a class, separate threads for running llama.cpp, structs for managing and settings - and only then wrapped into UI.
79

810
Additionally, chatTest console app is also added for testing purposes, since certain information (like memory used by the model) is printed outside of the original example (in llama.cpp, common.cpp, etc.).
@@ -36,17 +38,21 @@ Tested on Windows only for now. AVX2 releases only for now, older releases were
3638

3739
### Requirements
3840

41+
Code:
3942
* tinyfiledialogs https://sourceforge.net/projects/tinyfiledialogs/
40-
* Vulkan SDK (installer is preferred) https://vulkan.lunarg.com/#new_tab
4143
* imgui https://github.com/ocornut/imgui
44+
45+
Libraries:
46+
* Vulkan SDK (installer is preferred) https://vulkan.lunarg.com/#new_tab
4247
* SDL2 https://github.com/libsdl-org/SDL
43-
* OpenCL and CLBLAST if needed (see https://github.com/ggerganov/llama.cpp#clblast for installation guide)
48+
* If CLBLAST is needed: use releases of [OpenCL SDK](https://github.com/KhronosGroup/OpenCL-SDK) and [Clblast](https://github.com/CNugteren/CLBlast).
4449

4550
### Building on Windows
4651

4752
* Download this repo or `git clone` it
4853
* Use w64devkit https://github.com/skeeto/w64devkit/releases
49-
* Install all prerequisites according to w64devkit installation
54+
* Install all prerequisite libraries according to w64devkit installation (which is, in most cases, copying `lib` and `include` folders into `w64devkit/x86_64-w64-mingw32`)
55+
* Download and copy all prerequisite code according to Makefile
5056
* Launch w64devkit.exe and navigate to the project folder
5157
* `make chat` for CPU-only
5258
* `make chat_cl` for Clblast build

0 commit comments

Comments
 (0)