updated lib docs and README.md

pedro-devv · pedro-devv · commit 0fa4fdba437c · 2024-03-19T12:59:11.000Z
diff --git a/README.md b/README.md
@@ -41,6 +41,12 @@ for completion in completions {
 This repository hosts the high-level bindings (`crates/llama_cpp`) as well as automatically generated bindings to
 llama.cpp's low-level C API (`crates/llama_cpp_sys`). Contributions are welcome--just keep the UX clean!
 
+## Building
+
+Keep in mind that [llama.cpp](https://github.com/ggerganov/llama.cpp) is very computationally heavy, meaning standard 
+debug builds (running just `cargo build`/`cargo run`) will suffer greatly from the lack of optimisations. Therefore, unless 
+debugging is really necessary, it is highly recommended to build and run using Cargo's `--release` flag.
+
 ## License
 
 MIT or Apache-2.0, at your option (the "Rust" license). See `LICENSE-MIT` and `LICENSE-APACHE`.
diff --git a/crates/llama_cpp/src/lib.rs b/crates/llama_cpp/src/lib.rs
@@ -45,7 +45,7 @@
 //! ## Dependencies
 //!
 //! This crate depends on (and builds atop) [`llama_cpp_sys`], and builds llama.cpp from source.
-//! You'll need `libclang`, `cmake`, and a C/C++ toolchain (`clang` is preferred) at the minimum.
+//! You'll need at least `libclang` and a C/C++ toolchain (`clang` is preferred).
 //! See [`llama_cpp_sys`] for more details.
 //!
 //! The bundled GGML and llama.cpp binaries are statically linked by default, and their logs
@@ -62,6 +62,12 @@
 //! While panics are considered less critical, **this crate should never panic**, and any
 //! panic should be considered a bug. We don't want your control flow!
 //!
+//! ## Building
+//!
+//! Keep in mind that [llama.cpp][llama.cpp] is very computationally heavy, meaning standard
+//! debug builds (running just `cargo build`/`cargo run`) will suffer greatly from the lack of optimisations. Therefore, unless
+//! debugging is really necessary, it is highly recommended to build and run using Cargo's `--release` flag.
+//!
 //! ## Minimum Stable Rust Version (MSRV) Policy
 //!
 //! This crates supports Rust 1.73.0 and above.
