branch: elpa/pacmacs
commit 8ec58f38d9eec3dd4bdcc83a10eb823797131967
Author: rexim <[email protected]>
Commit: rexim <[email protected]>
Add Usage section for compile.el script
---
tools/README.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/tools/README.md b/tools/README.md
index 299e60f774..c6f55c7eb3 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -12,6 +12,12 @@ outputs the ATT to `./att.txt` file.
Compiles all the source code, treats warnings as errors and exits with
non-zero exit code on any error (which `cask build` does not yet).
+### Usage ###
+
+To run this script do
+
+ $ emacs -Q --script ./tools/compile.el
+
## pacmacs-rr.el ##
RR stands for Record and Replay. Additional module for recording and
