Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
quantumsheep authored Mar 5, 2020
1 parent e5e6619 commit d43d5db
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Chromaprint C++ Boilerplate
Start a Chromaprint C++ project faster than ever!
You just need to clone this repository wherever you want.
Start a [Chromaprint](https://github.com/acoustid/chromaprint) C++ project faster than ever!

# How to clone the repository
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.

## With SSH
```bash
git clone --recursive git@github.com:quantumsheep/chromaprint-boilerplate.git
```

## Without SSH
```bash
git clone --recursive https://github.com/quantumsheep/chromaprint-boilerplate.git
```

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

In the `build` directory:
In the `build` directory do those commands that will compile the sources with chromaprint linked:
```bash
cmake ..
cmake --build .
Expand Down

0 comments on commit d43d5db

Please sign in to comment.