Skip to content

docs: add build instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: add build instructions #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# AGENTS

## Build from source

- Install prerequisites:
- CMake
- C/C++ compiler toolchain (e.g. `build-essential`)
- Development files for libcurl (curl support is enabled by default)

On Debian/Ubuntu:
```bash
sudo apt-get update
sudo apt-get install build-essential cmake libcurl4-openssl-dev
```

- Configure and build:
```bash
cmake -B build
cmake --build build --config Release
```
Comment on lines +16 to +20
Copy link

@coderabbitai coderabbitai bot Sep 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use generator-correct Release config and portable parallel flag

On single-config generators (Unix Makefiles/Ninja), --config Release is ignored; set -DCMAKE_BUILD_TYPE=Release. Use --parallel (CMake ≥3.12) instead of relying on -j passthrough.

- - Configure and build:
-   ```bash
-   cmake -B build
-   cmake --build build --config Release
-   ```
+ - Configure and build:
+   - Single-config generators (Unix Makefiles/Ninja):
+     ```bash
+     cmake -B build -DCMAKE_BUILD_TYPE=Release
+     cmake --build build --parallel
+     ```
+   - Multi-config generators (Visual Studio/Xcode):
+     ```bash
+     cmake -B build
+     cmake --build build --config Release --parallel
+     ```
🤖 Prompt for AI Agents 
In AGENTS.md around lines 16 to 20, the build instructions use --config Release
and assume -j passthrough which is incorrect for single-config generators;
update the docs to show two cases: for single-config generators (Unix
Makefiles/Ninja) add -DCMAKE_BUILD_TYPE=Release when invoking cmake -B build and
use cmake --build build --parallel, and for multi-config generators (Visual
Studio/Xcode) keep cmake -B build and use cmake --build build --config Release
--parallel; replace the existing two-line snippet with these two short examples
and note which generators they apply to.

Add `-j` to the build command for parallel compilation or pass `-DLLAMA_CURL=OFF` to disable curl.