Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
heapwolf committed Jul 5, 2019
1 parent 06dc0bb commit 14c69d7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,21 @@ only way to log anything in C++ is with a huge obnoxious framework and 2.
seriously, GTFO.

# USAGE

#### INSTALL
This module is designed to work with the [`datcxx`][0] build tool. To add this
module to your project us the following command...

```bash
build add heapwolf/debug
```

#### CODE
Construct an instance of `Debug` with a name. The instance will allow you to
toggle the debug output for different parts of your program.

The DEBUG environment variable is used to enable these based on delimited names.

#### CODE
```c++
#include "./deps/heapwolf/debug/index.hxx"

Expand Down

0 comments on commit 14c69d7

Please sign in to comment.