aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNathan Weizenbaum <nweiz@google.com>2012-11-30 17:21:16 -0800
committerNathan Weizenbaum <nweiz@google.com>2012-11-30 17:21:16 -0800
commitf5850d6c62b00a637f022ce579d9a0337e50b91b (patch)
tree3c9e9dbad23dd1cadd2e1c2c8927b836669841be /README.md
parentd1ef10b847d3df755018b650aeca80226bad7e33 (diff)
Add LICENSE/README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a92d44
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+This package provides tagged workspaces in Emacs, similar to workspaces in
+windows managers such as Awesome and XMonad (and somewhat similar to multiple
+desktops in Gnome or Spaces in OS X).
+
+perspective.el provides multiple workspaces (or "perspectives") for each Emacs
+frame. This makes it easy to work on many separate projects without getting lost
+in all the buffers.
+
+Each perspective is composed of a window configuration and a set of buffers.
+Switching to a perspective activates its window configuration, and when in a
+perspective only its buffers are available by default.
+
+It's recommended that you install perspective.el from [Marmalade][] using `M-x
+package-install`. Alternately, you may put it in your load path and run
+`(require 'perspective)`.
+
+[Marmalade]: http://marmalade-repo.org/