Add README.md
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@ -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.
|
Reference in New Issue
Block a user