|author||Drew DeVault <firstname.lastname@example.org>||2017-04-29 10:54:08 -0400|
|committer||Drew DeVault <email@example.com>||2017-04-29 10:54:08 -0400|
1 files changed, 35 insertions, 0 deletions
diff --git a/HACKING.md b/HACKING.md
new file mode 100644
@@ -0,0 +1,35 @@
+Use `sway_log(importance, fmt, ...)` to log. The following importances are
+* `L_DEBUG`: Debug messages, only shows with `sway -d`
+* `L_INFO`: Informational messages
+* `L_ERROR`: Error messages
+`sway_log` is a macro that calls `_sway_log` with the current filename and line
+number, which are written into the log with your message.
+In the compositor, assertions *must not* be fatal. All error cases must be
+handled as gracefully as possible - crashing the compositor will make the user
+lose all of their work.
+Use `sway_assert(condition, fmt, ...)` to perform an assertion. This returns
+`condition`, which you must handle if false. An error will be logged if the
+Outside of the compositor (swaymsg, swaybar, etc), using `assert.h` is
+## Building against a local wlc
+1. Build wlc as described [here](https://github.com/Cloudef/wlc#building)
+2. Inside your sway source folder, tell `cmake` to use your local version of wlc:
+ -DWLC_LIBRARIES=path/to/wlc/target/src/libwlc.so \
+ -DWLC_INCLUDE_DIRS=path/to/wlc/include .