aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdriean Khisbe <adriean.khisbe@live.fr>2014-06-25 18:41:37 +0200
committerAdriean Khisbe <adriean.khisbe@live.fr>2014-06-25 18:56:27 +0200
commit5db7eec582eb66def814c3f316016d798feb4d9b (patch)
tree6e905967d3c6611ff74fe1df5f2ea01b7dfaf99b /README.md
parent0b7893ed00de1ffab8819c9627715649eb2839c5 (diff)
Add some usage documentation in readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0a92d44..3286ab2 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
+# Perspective for Emacs
+
+## Description
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
+`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.
@@ -15,3 +18,24 @@ package-install`. Alternately, you may put it in your load path and run
`(require 'perspective)`.
[Marmalade]: http://marmalade-repo.org/
+
+## Usage
+
+To active perspective use `(persp-mode)`
+
+Command are all prefixed by `C-x x`.
+Here are the main commands:
+
+
+### Key -- Command
+- `s` -- `'persp-switch`
+- `k` -- `'persp-remove-buffer`
+- `c` -- `'persp-kill`
+- `r` -- `'persp-rename`
+- `a` -- `'persp-add-buffer`
+- `A` -- `'persp-set-buffer`
+- `i` -- `'persp-import`
+- `n` -- `'persp-next`
+- `<rigth>` -- `'persp-next`
+- `p` -- `'persp-prev`
+- `<left>` -- `'persp-prev`