Skip to content

Commit

Permalink
Fix link in README; closes #4
Browse files Browse the repository at this point in the history
  • Loading branch information
eliabieri authored Sep 10, 2022
1 parent c3f47e5 commit ba7b833
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ int main() {

### What if I don't use CMake ? ⚠️

It is not recommended to use this API without CMake. In the build steps of this project, the latest version of the list is downloaded directly from the [BLNS repository](https://github.com/minimaxir/big-list-of-naughty-string). The list is often updated. You should use its latest version to test your code with the state-of-the-art strings. CMake is the easiest way to implement this : you have the latest version of [BLNS.txt](https://raw.githubusercontent.com/minimaxir/big-list-of-naughty-strings/master/blns.txt) at every clean build. Moreover, if you use CPM as indicated above, you will benefit from the latest version of the API without changing your code.
It is not recommended to use this API without CMake. In the build steps of this project, the latest version of the list is downloaded directly from the [BLNS repository](https://github.com/minimaxir/big-list-of-naughty-strings). The list is often updated. You should use its latest version to test your code with the state-of-the-art strings. CMake is the easiest way to implement this : you have the latest version of [BLNS.txt](https://raw.githubusercontent.com/minimaxir/big-list-of-naughty-strings/master/blns.txt) at every clean build. Moreover, if you use CPM as indicated above, you will benefit from the latest version of the API without changing your code.

If you don't want (of can't) use CMake, you can clone this repository or add it as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to use the API. However, you will need to implement your own way to download [BLNS.txt](https://raw.githubusercontent.com/minimaxir/big-list-of-naughty-strings/master/blns.txt) at the root of the repository. Please, ensure that:
- :heavy_check_mark: The latest version of BLNS.txt is downloaded automatically at every build
Expand Down

0 comments on commit ba7b833

Please sign in to comment.