[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
- [nongnu] branch elpa/j-mode created (now e8725ac), ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode ad688ee 01/56: Initial code base, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 01e8c39 02/56: Removing todo, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode cedc335 04/56: Updates to face macro, to j-console handling. Added key-bindings, added drop down., ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode ebf94ae 03/56: Added the beginning of j-console integration, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 14327d8 05/56: Adding font-lock for variable assignment, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode c6865b5 07/56: Initial commit for help documentation look-up functionality., ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 529cf67 06/56: Swaping progn with eval-when-compile in faces macro, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode d6fd35d 08/56: Updating README with information about the new faces added from j-mode,
ELPA Syncer <=
- [nongnu] elpa/j-mode 41218f6 10/56: Doc-string updates, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 140c2b6 12/56: Updated README and cleaned up docs a bit, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 50b6ad1 13/56: Updating doc strings, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode f4ede4b 18/56: Fixing unbalanced parenthesis, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 2e1ffe7 17/56: Merge branch 'modulate' of github.com:zellio/j-mode into modulate, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 0bf1acd 35/56: Fix "\\." (Suffix / Outfix) for `j-help-voc-alist', ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 0d2ba51 26/56: Adding warning about executable name clash with a Java package, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 3509c2d 15/56: Added branch search function for more intelligent symbol detection, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode b470f04 19/56: Removing the -> macro, ELPA Syncer, 2021/08/29
- [nongnu] elpa/j-mode 94a4d08 16/56: 1.0.0 Release, ELPA Syncer, 2021/08/29