emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/j-mode d6fd35d 08/56: Updating README with information abo


From: ELPA Syncer
Subject: [nongnu] elpa/j-mode d6fd35d 08/56: Updating README with information about the new faces added from j-mode
Date: Sun, 29 Aug 2021 11:20:44 -0400 (EDT)

branch: elpa/j-mode
commit d6fd35dca8911f5d4d833c79df33fad104f32d5d
Author: Zachary Elliott <zach@nyu.edu>
Commit: Zachary Elliott <zach@nyu.edu>

    Updating README with information about the new faces added from j-mode
---
 .gitignore |  7 +++++++
 README.md  | 34 +++++++++++++++++++++++++++++++---
 2 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..9b701fe
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+# temporary files
+*~
+*\#*\#
+*.\#*
+
+# j-help data cache
+.help_cache/
\ No newline at end of file
diff --git a/README.md b/README.md
index 48ea201..c39a74f 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,38 @@ Provides font-lock and basic REPL integration for the
 The only method of installation is to check out the project, add it
 to the load path, and load normally. This may change one day.
 
-    ;; Put this in your emacs config
-    (add-to-list 'load-path "/path/to/j-mode/")
-    (load "j-mode")
+```lisp
+;; Put this in your emacs config
+(add-to-list 'load-path "/path/to/j-mode/")
+(load "j-mode")
+```
 
+## font-lock Configuration
+
+j-mode relies on four newly introduced faces to help colour the various parts 
of
+speech. Those faces are `j-verb-face` `j-adverb-face` `j-conjunction-face`
+`j-other-face`. They can be changed like any other face to help bring them in
+line with what ever your display configuration is.
+
+```lisp
+(custom-set-face
+ '(j-verb-face ((t (:foreground "Red"))))
+ '(j-adverb-face ((t (:foreground "Green"))))
+ '(j-conjunction-face ((t (:foreground "Blue"))))
+ '(j-other-face ((t (:foreground "Black")))))
+```
+
+If you are not interested in coloring the various parts of speech you can also
+just set all of the faces to be the same.
+
+```lisp
+(let ((default-color "Black"))
+  (custom-set-face
+   '(j-verb-face ((t (:foreground default-color :background "Clear"))))
+   '(j-adverb-face ((t (:foreground default-color :background "Clear"))))
+   '(j-conjunction-face ((t (:foreground default-color :background "Clear"))))
+   '(j-other-face ((t (:foreground default-color :background "Clear"))))))
+```
 
 ## REPL Interaction
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]