nerdcruft/libcruft-util
1
0
Fork 0
Code Issues Releases Activity

README: consolidate README files

Browse Source
This commit is contained in:
Danny Robson 2018-06-05 09:35:33 +10:00
parent 50f43d2193
commit c6cefe219d
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README
View File

@ -1,3 +0,0 @@
A simple cross-platform C++ utility library.
Supported compilers: >=clang-5.x, >=gcc7.x; specifically, we require c++17 features such as structured bindings which aren't present in older compilers. No attempt has been made to compile under MSVC.

12
README.asc → README.adoc
View File

@ -1,4 +1,12 @@
environment variables: == libcruft-util
A simple cross-platform C++ utility library.
Supported compilers: >=clang-5.x, >=gcc7.x; specifically, we require cxx17 features such as structured bindings which aren't present in older compilers. No attempt has been made to compile under MSVC.
=== Environment Variables
The following variables can be defined at runtime to change the library behaviour.
DEBUG:: whether to initialise basic debugging features at load time. the value is irrelevant; the test is for whether the variable is defined. DEBUG:: whether to initialise basic debugging features at load time. the value is irrelevant; the test is for whether the variable is defined.
DEBUG_WAIT:: whether to wait for a debugger to attach before executing `main`. DEBUG_WAIT:: whether to wait for a debugger to attach before executing `main`.
@ -8,3 +16,5 @@ BREAK_LEVEL:: minimum log level that will trigger a breakpoint
JOB_THREADS:: default number of threads to spin up for job queues. JOB_THREADS:: default number of threads to spin up for job queues.
JOB_DEPTH:: the default size of the pending work item queue for a job queue. JOB_DEPTH:: the default size of the pending work item queue for a job queue.
Ideally one would not resort to using these variables, but they may make debugging a little easier in some circumstances.