summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorantirez <antirez@gmail.com>2016-07-10 12:25:07 +0200
committerantirez <antirez@gmail.com>2016-07-10 12:25:07 +0200
commita9f98a96c493d266a0216a79d0a5d347527183bc (patch)
treeebf0cdf18fdb71e5964ab38b4fb2d2fc7a445d0a /README.md
downloadfilo-a9f98a96c493d266a0216a79d0a5d347527183bc.tar.gz
filo-a9f98a96c493d266a0216a79d0a5d347527183bc.zip
First public alpha version.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a9c01fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Kilo
+===
+
+Kilo is a small text editor in less than 1K lines of code (counted with cloc).
+
+Usage: kilo <filename>
+
+Keys:
+
+ CTRL-S: Save
+ CTRL-Q: Quit
+ CTRL-F: Find string in file (ESC to esc, arrows to navigate)
+
+Kilo does not depend on any library (not even curses). It uses fairly standard
+VT100 (and similar terminals) escape sequences. The project is in alpha
+stage and was written in just a few hours taking code from my other two
+projects, load81 and linenoise.
+
+People are encouraged to use it as a starting point to write other editors
+or command line interfaces that are more advanced than the usual REPL
+style CLI.
+
+Kilo was written by Salvatore Sanfilippo aka antirez and is released
+under the BSD 2 clause license.