Skip to content

Commit

Permalink
readme: updated
Browse files Browse the repository at this point in the history
  • Loading branch information
kassane authored May 22, 2024
1 parent 2c73fc4 commit 1739516
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,42 @@

A [SIEVE cache](https://cachemon.github.io/SIEVE-website/) implementation for C++. Based on [D implementation](https://github.com/kubo39/sieve-cache-d).

### How to use
### How to Use

* Test on [godbolt](https://godbolt.org/z/fej9cM61j)

**or**

* Add in your `CMakeLists.txt`

```cmake
include(FetchContent)
FetchContent_Declare(
sieve
GIT_REPOSITORY "https://github.com/kassane/sieve-cache-cpp.git"
GIT_TAG main
)
set(BUILD_BENCH OFF)
set(BUILD_TESTS OFF)
FetchContent_GetProperties(sieve)
if(NOT sieve_POPULATED)
FetchContent_Populate(sieve)
endif()
set(SIEVE_PATH "${sieve_SOURCE_DIR}/include")
add_executable(${PROJECT_NAME} "demo.cc")
target_include_directories(${PROJECT_NAME} PRIVATE ${SIEVE_PATH})
```

```bash
$ cmake -B build
$ cmake --build build
# Run benchmark sample
# Run benchmark sample (if enabled)
$ cmake --build build --target bench
# Run unittest
# Run unittest (if enabled)
$ cmake --build build --target unittest
```

## LICENSE

See: [LICENSE](LICENSE)
See: [LICENSE](LICENSE)

0 comments on commit 1739516

Please sign in to comment.