Permalink
Browse files

Update README.

  • Loading branch information...
rejeep committed Jan 10, 2012
1 parent 33f1f66 commit 1e720266e2bc4af1e6d7b4d7411b6db48cc469e0
Showing with 31 additions and 18 deletions.
  1. +31 −18 README.markdown
View
@@ -1,37 +1,50 @@
# Drag Stuff
Drag Stuff is a minor mode for Emacs that makes it possible to drag
-stuff, such as words, region and lines, around in Emacs.
+stuff (words, region, lines) around in Emacs.
## Installation
-First download the **drag-stuff.el** file. If you use git you can
-fetch it from Github
- $ git clone git://github.com/rejeep/drag-stuff.git ~/.emacs.d/packages/drag-stuff
-
-Make sure it's in Emacs load-path
- (add-to-list 'load-path "~/.emacs.d/packages/drag-stuff")
-
-Then require it
+I recommend installing via ELPA, but manual installation is simple as well:
+
+ (add-to-list 'load-path "/path/to/drag-stuff")
(require 'drag-stuff)
## Usage
-To start drag-stuff
- (drag-stuff-mode t) or M-x drag-stuff-mode
+Start `drag-stuff-mode` using.
-Or if you want it to be done automatically
- (drag-stuff-global-mode t)
+ (drag-stuff-mode t)
+
+or
+
+ M-x drag-stuff-mode
### Drag line
To drag a line up and down. Put the cursor on that line and press
-**<M-up>** and **<M-down>**.
+`<M-up>` and `<M-down>`.
### Drag lines
To drag several lines up and down. Select the lines you want to drag
-and press **<M-up>** and **<M-down>**.
+and press `<M-up>` and `<M-down>`.
### Drag region
A region can be dragged to the left and right. Select the region you
-want to drag and press **<M-left>** and **<M-right>**.
+want to drag and press `<M-left>` and `<M-right>`.
### Drag word
-To drag a word. Just place the cursor on the word and press
-**<M-left>** and **<M-right>**.
+To drag a word. Place the cursor on the word and press `<M-left>` and
+`<M-right>`.
+
+For more information, see comments in `drag-stuff.el`.
+
+## Contribution
+Contribution is much welcome! Drag stuff is tested using [Ecukes](http://ecukes.info). When
+Adding New features, please write tests for them!
+
+To fetch Ecukes:
+
+ $ cd /path/to/drag-stuff
+ $ git submodule init
+ $ git submodule update
+
+Run the tests with:
+
+ $ ./util/ecukes/ecukes features

0 comments on commit 1e72026

Please sign in to comment.