yosh
/
hikari
1
0
Fork 0
Code Issues 5 Pull Requests Packages Projects Releases Wiki Activity

Document `DEBUG` build instructions in `README.md`

This commit is contained in:
raichoo 2020-11-08 10:47:40 +00:00
parent 6e9e012956
commit 502e18bb38
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -211,6 +211,17 @@ communication with PAM, which is required for password authentication)
make WITHOUT_SUID=YES install
```
#### Building a DEBUG build
In the case of a crash or a bug you should build a debug version of `hikari` and
try to reproduce the issue. This builds `hikari` with debug symbols and
sanitizers enabled. Extracting a stack trace for debugging purposes is also very
helpful if you are planning to submit a bug report.
```
make DEBUG=YES
```
## Community
The `hikari` community gears to be inclusive and welcoming to everyone, this is