Skip to content

Commit 6b98d9e

Browse files
committed
Added README
1 parent 50430a6 commit 6b98d9e

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.org

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
#+title: Eltbus is subtle
2+
3+
4+
* Guiding principles
5+
6+
** Don't distract
7+
- Extremely subtle colours
8+
9+
** Let syntax-highlighting do some work for you
10+
- Syntax highlighting is distracting, but it does serve a purpose.
11+
- Cryptic errors arise from unclosed comments and unterminated strings.
12+
13+
** Important things stand out
14+
- Highlighting Keywords, types and builtins provides a mental note
15+
to self that you haven't mistyped
16+
- giving a different color/formatting style to links helps too.
17+
18+
** Unimportant things dont
19+
- Comments are often useless when coding
20+
- Doc-comments are slightly more usefu
21+
- These stand out a little more than normal comments
22+
23+
-
24+
* A customary screenshot
25+
[[http://i.imgur.com/bCyoytv.png][Screenshot showing highlighting for C]]
26+
27+
* Get involved
28+
- Emacs has several font-faces. You can see this using
29+
#+begin_verbatim
30+
M-x list-faces-display
31+
#+end_verbatim
32+
33+
- If you are on a particular word and wonder what highlighting it
34+
uses, use
35+
#+begin_verbatim
36+
M-x describe-faces
37+
#+end_verbatim
38+
39+
- If you feel =eltbus= is doing a bad job with it, add another entry
40+
for it and send me a PR. If it is subtle enough, I will pull

0 commit comments

Comments
 (0)