Skip to content

Commit

Permalink
added docs to remind users to populate the submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcusDunn committed Jan 31, 2024
1 parent 4621868 commit 6bd56f3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,17 @@ This is the home for [llama-cpp-2][crates.io]. It also contains the [llama-cpp-s
This project was created with the explict goal of staying as up to date as possible with llama.cpp, as a result it is dead simple, very close to raw bindings, and does not follow semver meaningfully.

Check out the [docs.rs] for crate documentation or the [readme] for high level information about the project.

## Hacking

Ensure that when you clone this project you also clone the submodules. This can be done with the following command:

```sh
git clone --recursive https://github.com/utilityai/llama-cpp-rs
```

or if you have already cloned the project you can run:

```sh
git submodule update --init --recursive
```

0 comments on commit 6bd56f3

Please sign in to comment.