docs: update build instruction

Adriankhl · May 21, 2024 · eebefa3 · eebefa3
1 parent 9649fe3
commit eebefa3
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -453,20 +453,20 @@ mkdir build
 cd build
 ```
 
-Currently, vulkan backend is not working for embedding, don't add the `-DLLAMA_VULKAN=1` flag
-
 Run `cmake`.
 
 On Windows:
 ```
-cmake .. -GNinja -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl -DLLAMA_NATIVE=OFF  -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=Release
+cmake .. -GNinja -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl -DLLAMA_NATIVE=OFF -DLLAMA_VULKAN=ON -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=Release
 ```
 
 On Linux:
 ```
-cmake .. -GNinja -DLLAMA_NATIVE=OFF -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=Release
+cmake .. -GNinja -DLLAMA_NATIVE=OFF -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DLLAMA_VULKAN=ON -DCMAKE_BUILD_TYPE=Release
 ```
 
+Vulkan build works for Windows and Linux, if you want a cpu build, set `-DLLAMA_VULKAN=OFF` instead.
+
 For Android, set `$NDK_PATH` to your android ndk directory, then:
 ```
 cmake .. -GNinja -DCMAKE_TOOLCHAIN_FILE=$NDK_PATH\cmake\android.toolchain.cmake -DANDROID_ABI=arm64-v8a -DANDROID_PLATFORM=android-23 -DCMAKE_C_FLAGS="-mcpu=generic" -DCMAKE_CXX_FLAGS="-mcpu=generic" -DCMAKE_BUILD_TYPE=Release
@@ -480,4 +480,4 @@ ninja -j4
 ninja install
 ```
 
-The folder `../install/addons/godot_llm` can be copy directly to the `addons` folder of your godot project.
+The folder `../install/vulkan/addons/godot_llm` (`cpu` instead of `vulkan` for cpu build) can be copy directly to the `addons` folder of your godot project.