micro/README.md

43 lines
1.5 KiB
Markdown
Raw Normal View History

2016-03-21 00:28:36 +03:00
# Micro
2016-03-25 22:09:24 +03:00
[![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
2016-03-21 00:31:25 +03:00
[![Go Report Card](http://goreportcard.com/badge/zyedidia/micro)](http://goreportcard.com/report/zyedidia/micro)
2016-03-21 00:33:37 +03:00
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/micro/blob/master/LICENSE)
2016-03-21 00:28:36 +03:00
> 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
2016-03-22 01:39:16 +03:00
* Syntax highlighting (in over 75 languages!)
2016-03-21 00:28:36 +03:00
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.
2016-03-21 20:08:10 +03:00
Make sure your `GOPATH` is set.
2016-03-21 00:28:36 +03:00
```
2016-03-21 20:08:10 +03:00
$ git clone https://github.com/zyedidia/micro
$ cd micro
$ make
2016-03-21 00:28:36 +03:00
```
2016-03-21 20:08:10 +03:00
This will build micro and put the binary in the current directory. It will also install syntax highlighting files to `~/.micro/syntax`.
Alternatively you can use `make install` instead of `make` if you want the binary to be added to you `GOBIN` (make sure that it is set).
2016-03-21 00:28:36 +03:00
# 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)