diff --git a/README.md b/README.md new file mode 100644 index 00000000..4693667a --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Micro + +[![Go Report Card](https:///badge/github.com/zyedidia/micro)](https:///report/github.com/zyedidia/micro) +[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/gdamore/tcell/blob/master/LICENSE) + +> Micro is a work in progress, not suitable for use yet. + +Micro is a command line text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities +of modern terminals. + +# Features + +* Easy to use +* Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...) +* Extremely good mouse support +* True color support +* Cross platform +* Fast and efficient +* Syntax highlighting + +Not all of this is implemented yet -- see [progress](#progress) + +# Installation + +Installation is simple. For now you must build from source, although in the future binaries will be provided. + +``` +go get -u github.com/zyedidia/micro +``` + +# Progress + +Micro is very much a work in progress right now. To see what has and hasn't been done yet, see the [todolist](todolist.md) diff --git a/todolist.md b/todolist.md index 41c8d27c..8019e340 100644 --- a/todolist.md +++ b/todolist.md @@ -1,4 +1,4 @@ -- [ ] Readme +- [x] Readme - [x] Line numbers @@ -36,4 +36,3 @@ - [ ] Options - [ ] Add options such as tab size, use tabs or use spaces, etc... -