Skip to content

Commit 4f946fc

Browse files
committed
Clean up and clarify things in the README.
1 parent 242655d commit 4f946fc

File tree

2 files changed

+23
-42
lines changed

2 files changed

+23
-42
lines changed

README.md

+23-42
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
Sublime Column Select
2-
=====================
1+
# Sublime Column Select
32

4-
This plugin provides an alternate behavior for Sublime keyboard column selection. I often found it challenging to select columns with lines that were shorter than the rest.
3+
This plugin provides an alternate behavior for Sublime keyboard column selection. The differences are:
54

6-
Downloading
7-
-----------
5+
* Allows reversing direction (go down too far, just go back up).
6+
* Added PageUp/PageDown, Home/End, and mouse selection.
7+
* Skip rows that are too short.
8+
* If you start at the end of a line, then it will stay at the end of each line.
9+
10+
![example](demo1.gif)
11+
12+
## Installing
813
The best way to download and install Sublime Column Select is to use the Package Control plugin. If you do not already have it installed, it's really the best way to manage your packages.
914

1015
For users new to the package manager:
@@ -24,37 +29,20 @@ Alternatively, you can fetch from github:
2429

2530
and place it in your packages directory.
2631

27-
Configuring
28-
-----------
29-
No need to configure anything. By default it uses the default keystroke for column selection, plus a few extras. These keystrokes will select the same column in the next or previous line, page, or until the beginning/end of the document.
30-
31-
Windows:
32-
33-
- Ctrl-Alt-Up / Ctrl-Alt-Down: Up/down one line.
34-
- Ctrl-Alt-PageUp / Ctrl-Alt-PageDown: Up/down one page.
35-
- Ctrl-Alt-Home: Up until the beginning of the document.
36-
- Ctrl-Alt-End: Down until the end of the document.
37-
38-
- Ctrl-Alt-Right-click: Select current column in all lines from the cursor to the row where you clicked.
39-
40-
Linux:
32+
## Usage
33+
By default it uses the default keystroke for column selection, plus a few extras. These keystrokes will select the same column in the next or previous line, page (the visible region of the file), or until the beginning/end of the file.
4134

42-
- Alt-Shift-Up / Ctrl-Alt-Down: Up/down one line.
43-
- Alt-Shift-PageUp / Ctrl-Alt-PageDown: Up/down one page.
44-
- Alt-Shift-Home: Up until the beginning of the document.
45-
- Alt-Shift-End: Down until the end of the document.
46-
47-
- Ctrl-Alt-Right-click: Select current column in all lines from the cursor to the row where you clicked.
48-
49-
OS X:
50-
51-
- Ctrl-Shift-Up / Ctrl-Alt-Down: Up/down one line.
52-
- Ctrl-Shift-PageUp / Ctrl-Alt-PageDown: Up/down one page.
53-
- Ctrl-Shift-Home: Up until the beginning of the document.
54-
- Ctrl-Shift-End: Down until the end of the document.
55-
56-
- Ctrl-Shift-Right-click: Select current column in all lines from the cursor to the row where you clicked.
35+
Command | Mac | Windows | Linux
36+
------- | --- | ------- | -----
37+
Up | Ctrl + Shift + Up | Ctrl + Alt + Up | Alt + Shift + Up
38+
Down | Ctrl + Shift + Down | Ctrl + Alt + Down | Alt + Shift + Down
39+
Page Up | Ctrl + Shift + PageUp | Ctrl + Alt + PageUp | Alt + Shift + PageUp
40+
Page Down | Ctrl + Shift + PageDown | Ctrl + Alt + PageDown | Alt + Shift + PageDown
41+
Beginning of file | Ctrl + Shift + Home | Ctrl + Alt + Home | Alt + Shift + Home
42+
End of file | Ctrl + Shift + End | Ctrl + Alt + End | Alt + Shift + End
43+
Select to mouse cursor | Ctrl + Shift + Right-click | Ctrl + Alt + Right-click | Ctrl + Alt + Right-click
5744

45+
### Custom Keystrokes
5846

5947
If you want to use a different keystroke, go to "Preferences" then "Key Bindings - User", and add an entry like this:
6048

@@ -67,13 +55,6 @@ If you want to use a different keystroke, go to "Preferences" then "Key Bindings
6755

6856
Do not include the trailing comma if it is the last entry.
6957

70-
Using
71-
-----
72-
You should be able to place the character on any position on the line, and then use the keystrokes to add additional carets (cursors) to the next/previous lines. It will skip over lines that are too short.
73-
74-
It will behave differently if the cursor is at the end of the line. In this case, it will select the end of every line.
75-
76-
Contact
77-
-------
58+
## Contact
7859
If you find a bug, or have suggestions, head over to the github page:
7960
https://github.com/ehuss/Sublime-Column-Select

demo1.gif

26 KB
Loading

0 commit comments

Comments
 (0)