branch: elpa/pacmacs
commit a9ab4c18c892bb50ee811db7a2482f1ec61ceded
Merge: 75e26090e5 bdbf7144d2
Author: Alexey Kutepov <[email protected]>
Commit: Alexey Kutepov <[email protected]>
Merge pull request #190 from codingteam/usage-for-tools
Usage for tools
---
tools/README.md | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/tools/README.md b/tools/README.md
index 299e60f774..07b5c7bf25 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -2,17 +2,30 @@
Tools that help to develop the game
+## pacmacs-rr.el ##
+
+RR stands for Record and Replay. Additional module for recording and
+replaying integration test cases.
+
## att.el ##
Runs `./it-cases/it-case03.el` it case using `pacmacs-rr` module and
outputs the ATT to `./att.txt` file.
+### Usage ###
+
+To run this script do
+
+ $ cask exec emacs -Q --load ./tools/att.el
+
## compile.el ##
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).
-## pacmacs-rr.el ##
+### Usage ###
+
+To run this script do
+
+ $ emacs -Q --script ./tools/compile.el
-RR stands for Record and Replay. Additional module for recording and
-replaying integration test cases.
