flanchan
/
libcow
1
0
Fork 0
Code Issues Pull Requests Projects Releases 6 Wiki Activity

update README

Browse Source
cpp
Avril 4 years ago
parent ba4fc89dd2
commit 3ec019fe87
Signed by: flanchan
GPG Key ID: 284488987C31F630
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File

9
README.md
Unescape View File

@ -37,8 +37,15 @@ By default, the install target is `/usr/local/`. Set the `PREFIX` variable when
$ make && sudo make install $ make && sudo make install
``` ```
Will build with the default optimisation configuration and install the following files/directories:
* /usr/local/lib/libcow.a
* /usr/local/lib/libcow.so
* /usr/local/include/cow.h
* /usr/local/include/cow.hpp
* /usr/local/include/cow/
### Notes ### Notes
* The `release` target specifies `-march=native` by default. This may be undesirable, if so, run `make MARCH="" release` instead. * The `release` target specifies `-march=native` by default. This may be undesirable, if so, set `TARGET_CPU=""` when running `make`.
* Many optimisation flags for the `release` configuration are specific to GCC (with graphite enabled by default), if builds on other compilers (or non-graphite enabled GCC builds) complain, either set the `OPT_FLAGS` env var or remove the problem flags from the Makefile. * Many optimisation flags for the `release` configuration are specific to GCC (with graphite enabled by default), if builds on other compilers (or non-graphite enabled GCC builds) complain, either set the `OPT_FLAGS` env var or remove the problem flags from the Makefile.
* `release` builds are stripped by default. run `make STRIP=: release` to prevent stripping. * `release` builds are stripped by default. run `make STRIP=: release` to prevent stripping.
* The targets are all built with `-fno-strict-aliasing`, but functions in the header file are still annotated with `restrict` needed. This is just to inform users that the function will assume the pointer is not aliased. (When included in C++, where `restrict` is not a keyword, we temporarily define it to be `__restrict__`, which is the GCC equivalent for C++). * The targets are all built with `-fno-strict-aliasing`, but functions in the header file are still annotated with `restrict` needed. This is just to inform users that the function will assume the pointer is not aliased. (When included in C++, where `restrict` is not a keyword, we temporarily define it to be `__restrict__`, which is the GCC equivalent for C++).

Write Preview
Loading…
Cancel
Save