soi-header/README.md

33 lines
805 B
Markdown
Raw Normal View History

2019-10-06 16:45:29 +02:00
# `#include <soi>`
Include soi and you're ready to go!
## dbg(...)
You can debug any expressions using the macro dbg().
## Configuration
You can set the following environment variables to customize the behaviour.
`SOI_COLOR`: By default, colored output is shown in case a terminal is connected.
You can force colors with `SOI_COLOR=1` and shut them off with `SOI_COLOR=0`.
2019-10-06 16:45:29 +02:00
`SOI_EOFCHECK`: By default, it is *not* checked, whether you have read all the
2019-10-06 16:45:29 +02:00
input. In case you pipe the input from a file or want to issue a proper EOF
character (Control D under linux or Control Z under Windows), you can enable
this check using `SOI_EOFCHECK=1`.
2019-10-06 16:45:29 +02:00
## Template
Using this header is as simple as:
```
#include <soi>
signed main() {
// your code goes here
}
```
It requires at least c++11 to function.