aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul W. Rankin <pwr@skeletons.cc>2020-11-06 13:44:09 +1000
committerPaul W. Rankin <pwr@skeletons.cc>2020-11-06 13:44:09 +1000
commitd6a709433ac159d654a194380e7cc454c8c59b8f (patch)
treefce703c28979b57b81222cc48bad087ccd3ce574
parent4f7f34b786c98b7fa8b5cd7408c9b455b8c60bc0 (diff)
downloadbinder-d6a709433ac159d654a194380e7cc454c8c59b8f.zip
Remove Markdown table from README
-rw-r--r--README.md28
-rw-r--r--binder.el28
2 files changed, 34 insertions, 22 deletions
diff --git a/README.md b/README.md
index 16e1399..9709665 100644
--- a/README.md
+++ b/README.md
@@ -53,20 +53,26 @@ You'll mostly interact with the project structure via the sidebar.
- `binder-reveal-in-sidebar (C-c ;)` finds the current file in the
sidebar
-Each project items is a file reference relative to the project
-directory. Items are displayed as:
+Each project item is a file reference relative to the project directory.
- x * name #tag1 #tag2
+Project items are displayed in a linear ordered list. Calling
+`binder-sidebar-find-file (RET)` or `binder-sidebar-find-file-other-window (o)`
+will visit the corresponding file.
-These things mean:
+Each item in the sidebar displays the following information:
-| key | description |
-|------|-------------------------------------------------|
-| x | item is included when concatenating the project |
-| * | item has notes |
-| ? | the item's corresponding file cannot be found |
-| name | the file name (or custom display name) |
-| #tag | arbitrary item tags |
+ 1. x -- denotes that this item is included when concatenating the
+ project (see **Concatentate** below)
+
+ 2. * -- denotes that this item has some notes (see **Notes** below),
+ or...
+
+ 3. ? -- denotes that the item's corresponding file cannot be found
+
+ 4. name -- either the file relative to the project directory or an
+ arbitrary display name
+
+ 5. #tag1 #tag2 ... -- arbitrary item tags (see **Tags** below)
An item's display name can be changed with `binder-sidebar-rename (r)`.
If a file cannot be found, relocate with `binder-sidebar-relocate (R)`.
diff --git a/binder.el b/binder.el
index 2cde842..9a02dcd 100644
--- a/binder.el
+++ b/binder.el
@@ -81,20 +81,26 @@
;; - binder-reveal-in-sidebar (C-c ;) finds the current file in the
;; sidebar
-;; Each project items is a file reference relative to the project
-;; directory. Items are displayed as:
+;; Each project item is a file reference relative to the project directory.
-;; x * name #tag1 #tag2
+;; Project items are displayed in a linear ordered list. Calling
+;; binder-sidebar-find-file (RET) or binder-sidebar-find-file-other-window (o)
+;; will visit the corresponding file.
-;; These things mean:
+;; Each item in the sidebar displays the following information:
-;; | key | description |
-;; |------|-------------------------------------------------|
-;; | x | item is included when concatenating the project |
-;; | * | item has notes |
-;; | ? | the item's corresponding file cannot be found |
-;; | name | the file name (or custom display name) |
-;; | #tag | arbitrary item tags |
+;; 1. x -- denotes that this item is included when concatenating the
+;; project (see **Concatentate** below)
+
+;; 2. * -- denotes that this item has some notes (see **Notes** below),
+;; or...
+
+;; 3. ? -- denotes that the item's corresponding file cannot be found
+
+;; 4. name -- either the file relative to the project directory or an
+;; arbitrary display name
+
+;; 5. #tag1 #tag2 ... -- arbitrary item tags (see **Tags** below)
;; An item's display name can be changed with binder-sidebar-rename (r).
;; If a file cannot be found, relocate with binder-sidebar-relocate (R).