Skip to content

Commit eba109d

Browse files
authored
Updated Readme with installation information
1 parent 46f2630 commit eba109d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,13 @@ git clone https://github.com/vinitjames/circularbuffer_CPP.git
2323
# Without CMAKE
2424
copy circular_buffer.h to your project
2525

26-
# With CMAKE to run tests
27-
Run ```mkdir build
28-
cd build
29-
cmake ..
30-
cmake --build .
31-
ctest ```
32-
to compile and run tests.
26+
# With CMAKE
27+
To locally build and run test run the following commands
28+
```sh
29+
$ mkdir build
30+
$ cd build
31+
$ cmake ..
32+
$ cmake --build .
33+
$ ctest
34+
```
35+
To include in project as a submodule just clone the repo in a subdirectory and use `add_subdirectory()` in the top level `CMakeLists.txt`

0 commit comments

Comments
 (0)