Skip to content

Commit 57db1f9

Browse files
committed
Update development docs for scikit-build-core. Closes #490
1 parent d2c5afe commit 57db1f9

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -190,17 +190,26 @@ If you find any issues with the documentation, please open an issue or submit a
190190

191191
This package is under active development and I welcome any contributions.
192192

193-
To get started, clone the repository and install the package in development mode:
193+
To get started, clone the repository and install the package in editable / development mode:
194194

195195
```bash
196196
git clone --recurse-submodules [email protected]:abetlen/llama-cpp-python.git
197197
cd llama-cpp-python
198198

199+
# Upgrade pip (required for editable mode)
200+
pip install --upgrade pip
201+
199202
# Install with pip
200203
pip install -e .
201204

202205
# if you want to use the fastapi / openapi server
203206
pip install -e .[server]
207+
208+
# to install all optional dependencies
209+
pip install -e .[all]
210+
211+
# to clear the local build cache
212+
make clean
204213
```
205214

206215
# How does this compare to other Python bindings of `llama.cpp`?

docs/index.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,12 @@ To get started, clone the repository and install the package in development mode
8282

8383
```bash
8484
git clone [email protected]:abetlen/llama-cpp-python.git
85+
cd llama-cpp-python
8586
git submodule update --init --recursive
8687
# Will need to be re-run any time vendor/llama.cpp is updated
87-
python3 setup.py develop
88+
89+
pip install --upgrade pip
90+
pip install -e .[all]
8891
```
8992

9093
## License

0 commit comments

Comments
 (0)