slap-editor/slap
1
1
Fork 0
mirror of https://github.com/slap-editor/slap.git synced 2024-10-26 13:17:38 +03:00
Code Issues Projects Releases Wiki Activity

Updates README

Browse Source
This commit is contained in:
Dan Kaplun 2014-06-25 02:05:03 -05:00
parent 47e13b6c43
commit c3e236825f
1 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -3,12 +3,19 @@
✋ slap
======
CLI text editor for the masses
slap is a Sublime-like terminal-based text editor that strives to make editing
from the terminal easier. It has:
slap is a Sublime-like editor that strives to make editing from the terminal
easier. It has **first-class mouse support**, **GUI editor-like keybindings**,
**copy/paste support**, **syntax highlighting for [many languages](https://github.com/isagalaev/highlight.js/tree/master/src/languages)**,
and many other features that will make you leave nano, vim, and emacs behind.
* first-class mouse support
* GUI editor-like [keybindings](https://github.com/slap-editor/slap/blob/master/slap.ini#L33)[*](#some-keys-dont-work)
* copying/pasting with OS clipboard support
* undo/redo
* syntax highlighting for [many languages](https://github.com/isagalaev/highlight.js/tree/master/src/languages)
* a Sublime-like file sidebar
* select word to highlight other occurrences; double-click to select word
* easy-to-use finding with regex support
* bracket matching
* ... many other features that will make you leave nano, vim, and emacs behind
Installation
------------
@ -29,13 +36,21 @@ change keybindings, styles, etc. You can also pass options in via command line:
$ slap --editor.tabSize 2 file.c
Issues
------
[Issues](https://github.com/slap-editor/slap/issues)
--------
### Some keys don't work!
Unfortunately most terminal emulators do not support certain keystrokes and as
such there is no way to handle them. These include `C-backspace`, `S-home/end`,
`C-S-up/down`, and `S-pageup/down`. These actions have alternate keybindings,
inspired by emacs and other editors.
### Windows support
Most terminal emulators in Windows do not support mouse events. Currently slap
does not work in Cygwin due to [joyent/node#6459](https://github.com/joyent/node/issues/6459).
Most terminal emulators in Windows do not support mouse events, PuTTY being a
notable exception. Currently slap does not work in Cygwin due to
[joyent/node#6459](https://github.com/joyent/node/issues/6459).
### Copying and pasting