summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoão Távora <joaotavora@gmail.com>2026-05-03 11:16:08 +0100
committerJoão Távora <joaotavora@gmail.com>2026-05-03 11:16:08 +0100
commit04c50e32e8f32afd68242e4dc28da02e8a45e237 (patch)
treeff953e4cf7a5d338b6c4225e17c5ebcdfaeffdcc /README.md
parent495b5117521beb6192b95da959c36007bca5b6cb (diff)
Per #27: Add opinionated mode-line entry pointsexternals/breadcrumb
* breadcrumb.el (breadcrumb-opinionated-mlf): New defcustom. (breadcrumb-opinionated-diminished-modes): New defcustom. (bc--saved-mlf, bc--saved-lighters): New variables. (bc--diminish): New function. (breadcrumb-opinionated-mode): New global minor mode. * README.md: Fix "is a global mode" grammar. Add "An opinionated mode line" section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2d343fa..2eb8585 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Breadcrumbs are sequences of short strings indicating where you are in
some big tree-like maze that is probably your code. Hopefully the
screenshot above clears it up.
-* `M-x breadcrumb-mode` is global mode. Will try to turn itself on
+* `M-x breadcrumb-mode` is a global mode. Will try to turn itself on
conservatively and only if there's a project.
* `M-x breadcrumb-local-mode` is a buffer-local minor mode, if you
@@ -38,11 +38,24 @@ and
```lisp
(:eval (breadcrumb-project-crumbs))
-```
+```
in your settings of the `mode-line-format` or `header-line-format`
variables.
+## An opinionated mode line
+
+If you had trouble understanding the previous section and just want to
+get breadcrumbs on the mode-line, you can call `M-x
+breadcrumb-opinionated-mode`. Looks like this:
+
+![opinionated](./opinionated.png)
+
+Call it again to turn it off. Also, you probably want to check how
+the variable `breadcrumb-opinionated-mlf` is built so you can
+adjust/customize it. Or just steal ideas from it into your own
+`mode-line-format` `header-line-format` customizations.
+
## Tweaks
The shape and size of each breadcrumb groups may be tweaked via