From 96c85498c019e381d0aeed2e33e626563563ea8c Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Wed, 7 Mar 2012 09:28:43 -0500
Subject: Documentation overhaul with Discount (Markdown implementation). The
 standard LuaDoc template is no longer used. Instead, the new
 `scripts/markdowndoc.lua` has the template for LuaDoc and
 `scripts/update_doc` has the template for the Manual. Also added README,
 CHANGELOG, and THANKS files.

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..6bc94601
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Textadept
+
+## Overview
+
+Textadept is a fast, minimalist, and ridiculously extensible cross-platform text
+editor for programmers. Written in a combination of C and [Lua][] and
+relentlessly optimized for speed and minimalism over the years, Textadept is an
+ideal editor for programmers who want endless extensibility options without
+sacrificing speed or succumbing to code bloat and featuritis.
+
+[Lua]: http://lua.org
+
+## Features
+
+* Self-contained executable -- no installation necessary.
+* Entirely keyboard driven.
+* Unlimited split views.
+* Support for over 80 programming languages.
+* Powerful snippets and key commands.
+* Code autocompletion and API lookup.
+* Unparalleled extensibility.
+
+## Requirements
+
+In its bid for minimalism, Textadept has no dependencies on Windows and Mac OSX
+operating systems and depends only on [GTK+ 2.0][] version 2.16 or greater on
+Linux. Lua is pre-compiled into Textadept on all platforms and a GTK runtime is
+included on Windows and Mac OSX.
+
+[GTK+ 2.0]: http://gtk.org
+
+## Download
+
+Download Textadept from the [project page][].
+
+[project page]: http://foicica.com/textadept
+
+## Installation and Usage
+
+Textadept comes with a comprehensive manual and API documentation in the `doc/`
+directory. They are also available [online][].
+
+[online]: http://foicica.com/textadept
+
+## Contact
+
+Contact me by email: mitchell.at.foicica.com.
+
+There is also a [mailing list][].
+
+[mailing list]: http://foicica.com/lists
-- 
cgit v1.2.3