Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added project compilation instructions.
Closes #9.
  • Loading branch information
Snaipe committed Nov 8, 2015
1 parent fa204e8 commit b5d6bb6
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -10,6 +10,7 @@
!LICENSE
!HEADER
!README.md
!INSTALL.md
!ChangeLog
!doc/*

Expand Down
29 changes: 29 additions & 0 deletions INSTALL.md
@@ -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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

b5d6bb6e

Please sign in to comment.