# Micro
-[](https:///report/github.com/zyedidia/micro)
-[](https://github.com/gdamore/tcell/blob/master/LICENSE)
+[](https://travis-ci.org/zyedidia/micro)
+[](http://goreportcard.com/report/zyedidia/micro)
+[](https://gitter.im/zyedidia/micro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[](https://github.com/zyedidia/micro/blob/master/LICENSE)
-> Micro is a work in progress, not suitable for use yet.
+> Micro is very much a work in progress
-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.
+Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
+of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now.
+
+Here is a picture of micro editing its source code.
+
+
# 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)
+* Syntax highlighting (in over [75 languages](runtime/syntax)!)
+* Colorscheme support
+* True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
+* Search and replace
+* Sane defaults
+* Plugin system (plugins are written in Lua)
+* Undo and redo
+* Unicode support
+* Copy and paste with the system clipboard
+* Small and simple
+* Easily configurable
# Installation
-Installation is simple. For now you must build from source, although in the future binaries will be provided.
+### Homebrew
+
+If you are on Mac, you can install micro using Homebrew:
+
+```
+brew tap zyedidia/micro
+brew install --devel micro
+```
+
+Micro is devel-only for now because there is no released version.
+
+### Prebuilt binaries
+
+Nightly binaries:
+* [Mac OS X](http://zbyedidia.webfactional.com/micro/binaries/micro-osx.tar.gz)
+* [Linux 64](http://zbyedidia.webfactional.com/micro/binaries/micro-linux64.tar.gz)
+* [Linux 32](http://zbyedidia.webfactional.com/micro/binaries/micro-linux32.tar.gz)
+* [Linux Arm](http://zbyedidia.webfactional.com/micro/binaries/micro-linux-arm.tar.gz)
+* [FreeBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd64.tar.gz)
+* [FreeBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd32.tar.gz)
+* [OpenBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd64.tar.gz)
+* [OpenBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd32.tar.gz)
+* [NetBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd64.tar.gz)
+* [NetBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd32.tar.gz)
+* [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip)
+* [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip)
+
+To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
+
+### Building from source
+
+Micro is made in Go so you must have Go installed on your system to build it.
+
+Make sure that you have Go version 1.4 or greater.
+
+You can simply `go get` it.
+
+```
+go get -u github.com/zyedidia/micro/cmd/micro
+```
+
+### Clipboard support
+
+On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
+
+```
+$ sudo apt-get install xclip
+```
+
+If you don't have xclip or xsel, micro will use an internal clipboard for copy and paste, but it won't work with external applications.
+
+# Usage
+
+Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
+
+Micro also supports creating buffers from `stdin`:
```
-go get -u github.com/zyedidia/micro
+$ ifconfig | micro
```
-# Progress
+You can move the cursor around with the arrow keys and mouse.
+
+You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
+to enable word selection, and triple click to enable line selection.
+
+You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
+commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
+with a version number defined.
+
+### Help text
+
+See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
+configuration options.
+
+# Contributing
-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)
+If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
projects / micro.git / blobdiff