diff --git a/README.md b/README.md new file mode 100644 index 0000000..41eb284 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# RefCount + +RefCount is a reference counting (thus the name) and garbage collection library +for C. It is currently WIP and unfinished. + +### Building + +You can build using: +```sh +cmake -B build +make -C build +``` + +You can then run tests using: +```sh +make -C build test +``` + +### Documentation + +You can generate documentation with: +``` +doxygen +``` + +For now, you can look in the `test/` directory for some examples of the various +features of RefCount in use.