summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Lindqvist <benjamin.lindqvist@endian.se>2018-05-25 10:13:11 +0200
committerBenjamin Lindqvist <benjamin.lindqvist@endian.se>2018-05-25 10:13:11 +0200
commitabf6ceffce0e51e2895b30634948a856e4c2c68d (patch)
treeb27d44898e8f28eb53d40d247e9006c27e9addb0
parent9bc5157bf5a86da1d00702cae09c22f37a8dcb7c (diff)
updated README.md for new version
-rw-r--r--README.md46
1 files changed, 20 insertions, 26 deletions
diff --git a/README.md b/README.md
index d857ebc..e516275 100644
--- a/README.md
+++ b/README.md
@@ -7,37 +7,31 @@ instead. This information is only displayed if the echo area is not used
for anything else (but if you switch frame/window, it will replace whatever
message is currently displayed).
-NOTE: feebleline.el will look considerably better with a small border between
-the echo area and your other windows. This is best achieved with:
+The modeline gets restored when you toggle off feebleline-mode, of course.
- (window-divider-mode t)
- (setq window-divider-default-bottom-width 1)
- (setq window-divider-default-places (quote bottom-only))
+## Note on new version
+If you upgrade feebleline and it errors, something like "error running timer
+feebleline-mode-line-proxy-fn" or whatever, then just toggle feebleline-mode on
+and then off (i.e. M-x feebleline twice).
-But in the new version, feebleline checks your major version and applies this
-automatically when feebleline-mode gets activated. If you're on emacs 24 where
-window-divider-mode is not available, then feebleline does a silly hack where
-it keeps the modeline active, but shrinks it so that it looks like a
-border.
+Hopefully you'll like this new version better. If you don't, please share your
+reasoning in an issue :)
-The modeline gets restored when you toggle off feebleline-mode, of course.
## Customizations
-To customize what is displayed, a smidget of elisp is required. The basic idea
-is to override the following setq:
-
- (setq feebleline-mode-line-text
- '(("%6s" ((format "%s,%s" (format-mode-line "%l") (current-column))))
- (" : %s" ((if (buffer-file-name) (buffer-file-name)
- (buffer-name))) (face feebleline-bufname-face))
- ("%s" ((if (and (buffer-file-name) (buffer-modified-p)) "*" "" ))
- (face feebleline-asterisk-face))
- (" | %s" ((feebleline-previous-buffer-name))
- (face feebleline-previous-buffer-face))))
-
-Just replace the parts you don't like or add new ones as you please. If there's
-any interest in feebleline.el, we can hopefully get some example customizations
-(along with screenshots) posted on this page.
+There are some customizations available, check out
+
+ customize-group feebleline
+
+to see what you can do. An example init snippet would look something like:
+
+ (use-package feebleline
+ :ensure t
+ :custom (feebleline-show-git-branch t)
+ (feebleline-show-dir t)
+ (feebleline-show-time nil)
+ (feebleline-show-previous-buffer nil)
+ :config (feebleline-mode 1))
## Screenshots
These screenshots are a bit out of date. I promise to update them shortly.