Permalink
Browse files

Added project compilation instructions.

Closes #9.
  • Loading branch information...
Snaipe committed Oct 14, 2015
1 parent fa204e8 commit b5d6bb6d7b9ddbb5507389a07d01badd3cf62e5b
Showing with 30 additions and 0 deletions.
  1. +1 −0 .gitignore
  2. +29 −0 INSTALL.md
@@ -10,6 +10,7 @@
!LICENSE
!HEADER
!README.md
!INSTALL.md
!ChangeLog
!doc/*
@@ -0,0 +1,29 @@
# Compilation & installation instructions
## CMake options
### Developer options
These options are useful for developers that want to customize libcsptr.
* `-DSENTINEL=<ON|OFF>`: Use a sentinel for the variadic function parameters.
This must be left on for maximum compatibility. However, in case you target
embedded systems *and* your C compiler supports empty compound literals as
a nonstandard extension, you may want to turn it off.
This option is **ON** by default.
* `-DFIXED_ALLOCATOR=<ON|OFF>`: If turned on, directly use malloc/free as the
memory allocator, and ignore any allocator provided by `smalloc_allocator`.
This option is **OFF** by default.
### Maintainer options
These options target maintainers of libcsptr, and are not otherwise useful.
* `-DLIBCSPTR_TESTS=<ON|OFF>`: Compiles tests alongside libcsptr.
This option is **ON** by default.
* `-DCOVERALLS=<ON|OFF>`: Turns on coverage for libcsptr.
This option is **OFF** by default.
* `-DCOVERALLS_UPLOAD=<ON|OFF>`: Uploads coverage for libcsptr to coveralls.
The option is only relevant if `-DCOVERALLS=ON` is specified.
This option is **ON** by default.

1 comment on commit b5d6bb6

@tolstman66

This comment has been minimized.

tolstman66 commented on b5d6bb6 May 20, 2018

b5d6bb6e

Please sign in to comment.