aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorConstantine Vetoshev <gepardcv@gmail.com>2021-08-12 20:12:37 -0700
committerConstantine Vetoshev <gepardcv@gmail.com>2021-08-12 20:12:37 -0700
commita2337c80019f207a859ed63a12edd7eb73636740 (patch)
tree25985984cfbfc12288ae246a2101b40f2257074c /README.md
parente697017957675e610ce6cf9ddd86e2ea73665061 (diff)
Add TOC.
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 767621a..fba7ced 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,6 @@
![Test perspective](https://github.com/nex3/perspective-el/actions/workflows/test-perspective.yml/badge.svg)
-## Description
-
The Perspective package provides multiple named workspaces (or "perspectives")
in Emacs, similar to multiple desktops in window managers like Awesome and
XMonad, and Spaces on the Mac.
@@ -21,6 +19,21 @@ Each Emacs frame has a distinct list of perspectives.
Perspective supports saving its state to a file, so long-lived work sessions may
be saved and recovered as needed.
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
+- [Sample Use Cases](#sample-use-cases)
+ - [Multiple Projects](#multiple-projects)
+ - [[Yak Shaving](http://catb.org/jargon/html/Y/yak-shaving.html)](#yak-shavinghttpcatborgjargonhtmlyyak-shavinghtml)
+- [Similar Packages](#similar-packages)
+- [Compatibility](#compatibility)
+- [Installation](#installation)
+- [Usage](#usage)
+ - [Buffer switchers](#buffer-switchers)
+ - [Notes on `completing-read` Enhancements](#notes-on-completing-read-enhancements)
+- [Saving Sessions to Disk](#saving-sessions-to-disk)
+- [Customization](#customization)
+- [Some Musings on Emacs Window Layouts](#some-musings-on-emacs-window-layouts)
+<!-- markdown-toc end -->
+
## Sample Use Cases