From e00beb13b5c5fe98f43709afadc48a0331725391 Mon Sep 17 00:00:00 2001 From: Andrei Betlen Date: Fri, 28 Apr 2023 17:08:18 -0400 Subject: [PATCH] Update README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2c8c0a5..f1d9bd2 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,12 @@ Install from PyPI: pip install llama-cpp-python ``` +The above command will attempt to install the package and build build `llama.cpp` from source. +This is the recommended installation method as it ensures that `llama.cpp` is built with the available optimizations for your system. + +This method defaults to using `make` to build `llama.cpp` on Linux / MacOS and `cmake` on Windows. +You can force the use of `cmake` on Linux / MacOS setting the `FORCE_CMAKE=1` environment variable before installing. + ## High-level API ```python