Update development docs for scikit-build-core. Closes #490
This commit is contained in:
parent
d2c5afe5a3
commit
57db1f9570
2 changed files with 14 additions and 2 deletions
11
README.md
11
README.md
|
@ -190,17 +190,26 @@ If you find any issues with the documentation, please open an issue or submit a
|
||||||
|
|
||||||
This package is under active development and I welcome any contributions.
|
This package is under active development and I welcome any contributions.
|
||||||
|
|
||||||
To get started, clone the repository and install the package in development mode:
|
To get started, clone the repository and install the package in editable / development mode:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone --recurse-submodules git@github.com:abetlen/llama-cpp-python.git
|
git clone --recurse-submodules git@github.com:abetlen/llama-cpp-python.git
|
||||||
cd llama-cpp-python
|
cd llama-cpp-python
|
||||||
|
|
||||||
|
# Upgrade pip (required for editable mode)
|
||||||
|
pip install --upgrade pip
|
||||||
|
|
||||||
# Install with pip
|
# Install with pip
|
||||||
pip install -e .
|
pip install -e .
|
||||||
|
|
||||||
# if you want to use the fastapi / openapi server
|
# if you want to use the fastapi / openapi server
|
||||||
pip install -e .[server]
|
pip install -e .[server]
|
||||||
|
|
||||||
|
# to install all optional dependencies
|
||||||
|
pip install -e .[all]
|
||||||
|
|
||||||
|
# to clear the local build cache
|
||||||
|
make clean
|
||||||
```
|
```
|
||||||
|
|
||||||
# How does this compare to other Python bindings of `llama.cpp`?
|
# How does this compare to other Python bindings of `llama.cpp`?
|
||||||
|
|
|
@ -82,9 +82,12 @@ To get started, clone the repository and install the package in development mode
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone git@github.com:abetlen/llama-cpp-python.git
|
git clone git@github.com:abetlen/llama-cpp-python.git
|
||||||
|
cd llama-cpp-python
|
||||||
git submodule update --init --recursive
|
git submodule update --init --recursive
|
||||||
# Will need to be re-run any time vendor/llama.cpp is updated
|
# Will need to be re-run any time vendor/llama.cpp is updated
|
||||||
python3 setup.py develop
|
|
||||||
|
pip install --upgrade pip
|
||||||
|
pip install -e .[all]
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
Loading…
Reference in a new issue