Merge pull request Michael-F-Bryan#107 from szabgab/logging

explain how to turn on logging (Michael-F-Bryan#101)
blandger · May 22, 2024 · 0dafc69 · 0dafc69
2 parents c007c83 + fe6cfa1
commit 0dafc69
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -85,6 +85,23 @@ no-section-label = true
 curly-quotes = true
 ```
 
+## Logging, seeing progress
+
+In order to enable logging to the screen you need to set the `RUST_LOG` environment variable to `debug` or `info`.
+
+On Linux and macOS this can be done in the following way:
+
+```
+RUST_LOG=debug  mdbook-epub
+```
+
+On Windows CMD you need to set it on a separate line:
+
+```
+set RUST_LOG=debug
+mdbook-epub
+```
+
 
 ## Planned Features