Skip to content

Commit d43d5db

Browse files
authored
Update README.md
1 parent e5e6619 commit d43d5db

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
# Chromaprint C++ Boilerplate
2-
Start a Chromaprint C++ project faster than ever!
3-
You just need to clone this repository wherever you want.
2+
Start a [Chromaprint](https://github.com/acoustid/chromaprint) C++ project faster than ever!
3+
4+
# How to clone the repository
5+
Since we are using [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), the repository needs to be cloned in a specific way in order to fetch those submodules.
6+
7+
## With SSH
8+
```bash
9+
git clone --recursive git@github.com:quantumsheep/chromaprint-boilerplate.git
10+
```
11+
12+
## Without SSH
13+
```bash
14+
git clone --recursive https://github.com/quantumsheep/chromaprint-boilerplate.git
15+
```
416

517
# How to compile
6-
If you don't have the `build` directory just do `mkdir build`.
18+
If you don't have the `build` directory, you need to create it (`mkdir build`).
719

8-
In the `build` directory:
20+
In the `build` directory do those commands that will compile the sources with chromaprint linked:
921
```bash
1022
cmake ..
1123
cmake --build .

0 commit comments

Comments
 (0)