aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKelly Thomas Kline2021-06-08 02:44:31 +0000
committerBlaž Hrastnik2021-06-08 03:21:25 +0000
commit8f1eb7b2b03fd6907307f4e0065d0c43da22edb3 (patch)
tree55f6895a8851bc2a20b3b05e1f470acf4ff0f15a
parent82fdfdc38e8309a36330455e65cc34b7395ac299 (diff)
Add trace log primer to the Contributing section
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3ad44fff..f5a84d5d 100644
--- a/README.md
+++ b/README.md
@@ -78,6 +78,9 @@ Some suggestions to get started:
- You can look at the [good first issue](https://github.com/helix-editor/helix/labels/good%20first%20issue) label on the issue tracker.
- Help with packaging on various distributions needed!
+- To use print debugging to the `~/.cache/helix/helix.log` file, you must:
+ * Print using `log::info!`, `warn!`, or `error!`. (`log::info!("helix!")`)
+ * Pass the appropriate verbosity level option for the desired log level. (`hx -v <file>` for info, more `v`s for higher severity inclusive)
- If your preferred language is missing, integrating a tree-sitter grammar for
it and defining syntax highlight queries for it is straight forward and
doesn't require much knowledge of the internals.