Add small readme
This commit is contained in:
parent
b84f1ecc78
commit
2e4c735617
2 changed files with 34 additions and 2 deletions
33
README.md
Normal file
33
README.md
Normal file
|
@ -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)
|
|
@ -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...
|
||||
|
||||
|
|
Loading…
Reference in a new issue