branch: externals/indent-bars
commit 4a7f9c7528955bbcca1fd180235a85a601cf2c45
Author: JD Smith <[email protected]>
Commit: GitHub <[email protected]>
README: more compatibility detail
---
README.md | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 6abf0ca17f..db46fe6996 100644
--- a/README.md
+++ b/README.md
@@ -34,13 +34,18 @@ Not yet in a package database; simply clone and point
`use-package` at the corre
:hook ((python-mode yaml-mode) . indent-bars-mode)) ; or whichever modes you
prefer
```
-*Note*: For `indent-bars` to work, your port and version of emacs must
correctly support the `:stipple` face attribute. **Most do.**
+## Compatibility
+
+For `indent-bars` to work, your port and version of emacs must correctly
support the `:stipple` face attribute. **Most do.**
- All known UNIX/GNU Linux versions support stipples.
-- On Mac, the
[emacs-mac](https://bitbucket.org/mituharu/emacs-mac/src/master/) port has
stipple support (most easily installed [with
brew](https://github.com/railwaycat/homebrew-emacsmacport)).
+- On Mac, the
[emacs-mac](https://bitbucket.org/mituharu/emacs-mac/src/master/)[^1] port has
stipple support.
- Windows Emacs does not apparently support stipples.
+- `:stipple` is not supported (to my knowledge) on terminal emacs.
+
+[^1]: Most easily installed [with
brew](https://github.com/railwaycat/homebrew-emacsmacport))
-Please [open an issue](../../issues) with any updates/corrections to this
list. If you'd like to determine if stipples are working correctly in your
version of emacs, evaluate:
+Please [open an issue](../../issues) with any updates/corrections to this
list. If you'd like to determine if stipples are working correctly in your
version of emacs, enter (via `M-:`):
```elisp
(set-face-stipple 'default `(,(window-font-width) 1 ,(unibyte-string 1)))
