aboutsummaryrefslogtreecommitdiff
path: root/doc/01_Introduction.md
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2013-05-20 12:41:29 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2013-05-20 12:41:29 -0400
commitcd53300ce7b4b6ce90dcf95525fd7cc14efc3685 (patch)
tree907466d522cc6939b42b6d043e991c27e09a1cea /doc/01_Introduction.md
parentd042865f672d6708df80250c9c59172148a55f11 (diff)
downloadtextadept-cd53300ce7b4b6ce90dcf95525fd7cc14efc3685.tar.gz
textadept-cd53300ce7b4b6ce90dcf95525fd7cc14efc3685.zip
Rewrote the manual to use the active voice.
Diffstat (limited to 'doc/01_Introduction.md')
-rw-r--r--doc/01_Introduction.md75
1 files changed, 37 insertions, 38 deletions
diff --git a/doc/01_Introduction.md b/doc/01_Introduction.md
index ac577111..f3256c68 100644
--- a/doc/01_Introduction.md
+++ b/doc/01_Introduction.md
@@ -15,55 +15,54 @@ speed or succumbing to code bloat and featuritis.
### Fast
Textadept is _fast_. It starts up instantly and has a very responsive user
-interface. Even though the editor is mostly written in Lua, Lua is one of the
+interface. Even though the editor consists primarily of Lua, Lua is one of the
fastest scripting languages available. With the optional [LuaJIT][] version,
-Textadept is faster than ever before.
+Textadept runs faster than ever before.
[LuaJIT]: http://luajit.org
### Minimalist
-Textadept is minimalist. Not only is this apparent in its appearance, but the
-editor's C core was designed to never exceed 2000 lines of code and its Lua
-extension code is capped at 4000 lines. After more than 5 years of development,
-Textadept has maintained the same amount of code since its inception while
-evolving into a vastly superior editor.
+Textadept is minimalist. Not only does its appearance exhibit this, but the
+editor's C core pledges to never exceed 2000 lines of code and its Lua extension
+code avoids going beyond 4000 lines. After more than 5 years of development,
+Textadept contains the same amount of code since its inception while evolving
+into a vastly superior editor.
### Ridiculously Extensible
-Textadept is ridiculously extensible. It was designed to be that way from the
-very beginning. The features came later. Most of Textadept's internals use Lua,
-from syntax highlighting to opening and saving files to searching and replacing
-and more. Textadept gives you complete control over the entire application using
-Lua. You can do everything from moving the caret to changing menus and key
-commands on-the-fly to handling core events. The possibilities are limitless.
+Textadept is ridiculously extensible. Designed to be that way from the very
+beginning, the editor's features came later. Most of Textadept's internals use
+Lua, from syntax highlighting to opening and saving files to searching and
+replacing and more. Textadept gives you complete control over the entire
+application using Lua. Everything from moving the caret to changing menus and
+key commands on-the-fly to handling core events is possible. Its potential is
+vast.
![Split Views](images/splitviews.png)
## Manual Notation
-This manual uses notation that is worth clarifying.
-
-Directories and file paths are represented like this: */path/to/dir/* and
-*/path/to/file*. (On Windows machines, '/' and '\' can be used interchangeably
-as directory separators.) Any relative paths, paths that do not begin with '/'
-or "C:\", are relative to the location of Textadept. *~/* is denoted as the
-user's home directory. On Windows machines this is the value of the "USERHOME"
-environment variable, typically *C:\Users\username\\* or
-*C:\Documents and Settings\username\\*. On Linux, BSD, and Mac OSX machines
-it is the value of "$HOME", typically */home/username/* and */Users/username/*
-respectively.
-
-Key bindings are represented like this: `Ctrl+N`. They are not case sensitive.
-`Ctrl+N` means the "N" key is pressed with only the "Control" modifier key being
-held down, not the "Shift" modifier key. `Ctrl+Shift+N` means the "N" key is
-pressed with both "Control" and "Shift" modifiers held down. The same notation
-is applicable to key chains: `Ctrl+N, N` vs. `Ctrl+N, Shift+N`. In the first key
-chain, "Control" and "N" are pressed followed by "N" with no modifiers. The
-second has "Control" and "N" pressed followed by "Shift" and "N".
-
-When key bindings are mentioned, the Mac OSX and curses equivalents are often
-shown in parenthesis. It may be tempting to assume that some Windows/Linux keys
-map to Mac OSX's (e.g. `Ctrl` to `⌘`) or curses' (e.g. `Ctrl` to `^`), but this
-is not always the case. Please do not view the key equivalents as translations
-of one another, but rather as separate entities. This will minimize confusion.
+The manual represents directories and file paths like this: */path/to/dir/* and
+*/path/to/file*. (Windows machines use '/' and '\' interchangeably as directory
+separators.) Paths that do not begin with '/' or "C:\", are relative to the
+location of Textadept. *~/* denotes the user's home directory. On Windows
+machines this is the value of the "USERHOME" environment variable, typically
+*C:\Users\username\\* or *C:\Documents and Settings\username\\*. On Linux, BSD,
+and Mac OSX machines it is the value of "$HOME", typically */home/username/* and
+*/Users/username/*, respectively.
+
+The manual expresses key bindings like this: `Ctrl+N`. They are not case
+sensitive. `Ctrl+N` stands for pressing the "N" key while only holding down the
+"Control" modifier key, not the "Shift" modifier key. `Ctrl+Shift+N` stands for
+pressing the "N" key while holding down both the "Control" and "Shift"
+modifiers. The same notation applies to key chains like `Ctrl+N, N` and
+`Ctrl+N, Shift+N`. The first key chain represents pressing "Control" and "N"
+followed by "N" with no modifiers. The second represents pressing "Control" and
+"N" followed by "Shift" and "N".
+
+When mentioning key bindings, the manual often shows the Mac OSX and curses
+equivalents in parenthesis. It may be tempting to assume that some Windows/Linux
+keys map to Mac OSX's (e.g. `Ctrl` to `⌘`) or curses' (e.g. `Ctrl` to `^`), but
+this is not always the case. To minimize confusion, view key equivalents as
+separate entities, not as translations of one another.