branch: elpa/org-superstar
commit d17d10c443f3bf4e3568c02d2832c09bd9913ca8
Author: D. Williams <[email protected]>
Commit: D. Williams <[email protected]>
updated README
---
tests/README.org | 23 +++++++++++++++--------
1 file changed, 15 insertions(+), 8 deletions(-)
diff --git a/tests/README.org b/tests/README.org
index d5e24a60b3..de6fe48c95 100644
--- a/tests/README.org
+++ b/tests/README.org
@@ -4,14 +4,11 @@
This is where I will put cleaned up testing routines meant for testing
and debugging ~org-superstar-mode~. However, as the title suggests,
*none of these files are meant for normal package usage*. Consequently,
-I advise to run these files with a minimal setup (think =emacs -Q=) and
-only keep sessions involving them open /as long as necessary/. Since
-the things I want to test are very side effect reliant, I see myself
-forced to rely on ~advice~ and family. To further emphasize that I do
-not intend to ship any of these functions as part of my package, I use
-the non-standard (yet popular) naming convention
-~org-superstar/variable-name~. See below for the purpose of the
-individual files included here.
+I advise to run these files with a minimal setup (think =emacs -Q=). To
+further emphasize that I do not intend to ship any of these functions
+as part of my package, I use the non-standard (yet popular) naming
+convention ~org-superstar/variable-name~. See below for the purpose of
+the individual files included here.
** =sample.org=
A harmless sample file. An earlier version was used for the sample
@@ -39,5 +36,15 @@ different face properties to see if and how they work. It
essentially
serves as a test image for quick visual confirmation that all faces
are applied consistently.
+** =font-lock-test.el=
+A proper
[[https://www.gnu.org/software/emacs/manual/html_node/ert/index.html][ERT]]-based
testing module for testing basic fontification
+using [[https://github.com/Lindydancer/faceup][the ~faceup~ package]]. Simply
run either ~make font-lock~ or ~make
+font-lock-inlinetask~ to test whether ~org-superstar-mode~ applies the
+correct faces.
+
+*Note:* Due to the flexibility of Org, I advise against running this
+test in a live Emacs session, as false positives may occur from
+unexpected customization.
+
# LocalWords: README el
