3 [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
4 [![Go Report Card](http://goreportcard.com/badge/zyedidia/micro)](http://goreportcard.com/report/zyedidia/micro)
5 [![Join the chat at https://gitter.im/zyedidia/micro](https://badges.gitter.im/zyedidia/micro.svg)](https://gitter.im/zyedidia/micro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
6 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/micro/blob/master/LICENSE)
8 > Micro is very much a work in progress
10 Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
11 of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now.
13 Here is a picture of micro editing its source code.
15 ![Screenshot](./screenshot.png)
20 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
21 * Extremely good mouse support
23 * Syntax highlighting (in over [75 languages](runtime/syntax)!)
25 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
28 * Plugin system (plugins are written in Lua)
31 * Copy and paste with the system clipboard
37 Micro is devel-only for now because there is no released version.
41 If you are on OSX, you can install micro using Homebrew:
44 brew tap zyedidia/micro
45 brew install --devel micro
50 If you are on Arch Linux, you can install micro using the AUR:
53 wget https://aur.archlinux.org/cgit/aur.git/snapshot/micro-git.tar.gz
60 If you are on CRUX, you can install micro using the 6c37-git repo:
63 git clone https://github.com/6c37/crux-ports-git
64 cd crux-ports-git/micro
65 # make sure you have go installed!
72 * [Mac OS X](http://zbyedidia.webfactional.com/micro/binaries/micro-osx.tar.gz)
73 * [Linux 64](http://zbyedidia.webfactional.com/micro/binaries/micro-linux64.tar.gz)
74 * [Linux 32](http://zbyedidia.webfactional.com/micro/binaries/micro-linux32.tar.gz)
75 * [Linux Arm](http://zbyedidia.webfactional.com/micro/binaries/micro-linux-arm.tar.gz)
76 * [FreeBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd64.tar.gz)
77 * [FreeBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd32.tar.gz)
78 * [OpenBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd64.tar.gz)
79 * [OpenBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd32.tar.gz)
80 * [NetBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd64.tar.gz)
81 * [NetBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd32.tar.gz)
82 * [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip)
83 * [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip)
85 To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
87 ### Building from source
89 Micro is made in Go so you must have Go installed on your system to build it.
91 Make sure that you have Go version 1.4 or greater.
93 You can simply `go get` it.
96 go get -u github.com/zyedidia/micro/cmd/micro
101 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.
106 sudo apt-get install xclip
109 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.
113 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
115 Micro also supports creating buffers from `stdin`:
121 You can move the cursor around with the arrow keys and mouse.
123 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
124 to enable word selection, and triple click to enable line selection.
126 You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
127 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
128 with a version number defined.
132 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
133 configuration options.
137 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.