1 # ![Micro](./assets/logo.png)
3 [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
4 [![Go Report Card](https://goreportcard.com/badge/github.com/zyedidia/micro)](https://goreportcard.com/report/github.com/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)
7 [![Snap Status](https://build.snapcraft.io/badge/zyedidia/micro.svg)](https://build.snapcraft.io/user/zyedidia/micro)
9 Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
10 of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now.
12 As the name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use in a pinch, but micro also aims to be
13 enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).
15 Here is a picture of micro editing its source code.
17 ![Screenshot](./assets/micro-solarized.png)
19 To see more screenshots of micro, showcasing all of the default colorschemes, see [here](http://zbyedidia.webfactional.com/micro/screenshots.html).
21 You can also check out the website for Micro at https://micro-editor.github.io.
24 - [Features](#features)
25 - [Installation](#installation)
26 - [Prebuilt binaries](#prebuilt-binaries)
27 - [Package Managers](#package-managers)
28 - [Building from source](#building-from-source)
29 - [MacOS terminal](#macos-terminal)
30 - [Linux clipboard support](#linux-clipboard-support)
31 - [Colors and syntax highlighting](#colors-and-syntax-highlighting)
32 - [Plan9, Cygwin](#plan9-cygwin)
34 - [Documentation and Help](#documentation-and-help)
35 - [Contributing](#contributing)
41 * Easy to use and to install
42 * No dependencies or external files are needed -- just the binary you can download further down the page
44 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
45 * Keybindings can be rebound to your liking
47 * You shouldn't have to configure much out of the box (and it is extremely easy to configure)
49 * Nano-like menu to help you remember the keybindings
50 * Extremely good mouse support
51 * This means mouse dragging to create a selection, double click to select by word, and triple click to select by line
52 * Cross platform (It should work on all the platforms Go runs on)
53 * Note that while Windows is supported, there are still some bugs that need to be worked out
54 * Plugin system (plugins are written in Lua)
55 * Micro has a built-in plugin manager to automatically install, remove, and update all your plugins
57 * Automatic linting and error notifications
58 * Syntax highlighting (for over [90 languages](runtime/syntax)!)
60 * By default, micro comes with 16, 256, and true color themes.
61 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
63 * The snippet plugin can be installed with `> plugin install snippets`
64 * Copy and paste with the system clipboard
68 * Common editor things such as undo/redo, line numbers, Unicode support, softwrap...
70 Although not yet implemented, I hope to add more features such as autocompletion ([#174](https://github.com/zyedidia/micro/issues/174)) or a tree view ([#249](https://github.com/zyedidia/micro/issues/249)) in the future.
74 To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
76 If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).
80 All you need to install micro is one file, the binary itself. It's as simple as that!
82 Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
84 On that page you'll see the nightly release, which contains binaries for micro which are built every night,
85 and you'll see all the stable releases with the corresponding binaries.
87 If you'd like to see more information after installing micro, run `micro -version`.
89 ### Installation script
91 There is a great script which can install micro for you by downloading the latest prebuilt binary. You can find it at https://getmic.ro (the github repo for it is [here](https://github.com/benweissmann/getmic.ro)).
93 Then you can easily install micro:
95 $ curl https://getmic.ro | bash
97 The script will install the micro binary to the current directory.
99 See the [Github page](https://github.com/benweissmann/getmic.ro) for more information.
103 You can install micro using Homebrew on Mac:
109 On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop):
121 On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)
124 snap install micro --classic
127 On OpenBSD, micro is available in the ports tree. It is also available as a binary package.
133 ### Building from source
135 If your operating system does not have a binary release, but does run Go, you can build from source.
137 Make sure that you have Go version 1.5 or greater (Go 1.4 will work if your version supports CGO) and that your `GOPATH` env variable is set (I recommend setting it to `~/go` if you don't have one).
140 go get -d github.com/zyedidia/micro/cmd/micro
141 cd $GOPATH/src/github.com/zyedidia/micro
145 The binary will then be installed to `$GOPATH/bin` (or your `$GOBIN`).
147 Please make sure that when you are working with micro's code, you are working on your `GOPATH`.
149 You can install directly with `go get` (`go get -u github.com/zyedidia/micro/cmd/micro`) but this isn't recommended because it doesn't build micro with version information which is useful for the plugin manager.
153 If you are using MacOS, you should consider using [iTerm2](http://iterm2.com/) instead of the default Mac terminal. The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose `xterm defaults` under `Preferences->Profiles->Keys->Load Preset`. The newest versions also support true color.
155 ### Linux clipboard support
157 On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed.
162 sudo apt-get install xclip
165 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.
167 ### Colors and syntax highlighting
169 If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
170 you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
171 by pressing CtrlE in micro and typing `set colorscheme simple`.
173 If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
176 Many of the Windows terminals don't support more than 16 colors, which means
177 that micro's default colorscheme won't look very good. You can either set
178 the colorscheme to `simple`, or download a better terminal emulator, like
183 Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
184 means that micro is restricted to the platforms tcell supports. As a result, micro does not support
185 Plan9, and Cygwin (although this may change in the future). Micro also doesn't support NaCl (but NaCl is deprecated anyways).
189 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
191 Micro also supports creating buffers from `stdin`:
197 You can move the cursor around with the arrow keys and mouse.
199 You can also use the mouse to manipulate the text. Simply clicking and dragging
200 will select text. You can also double click to enable word selection, and triple
201 click to enable line selection.
203 # Documentation and Help
205 Micro has a built-in help system which you can access by pressing `Ctrl-E` and typing `help`. Additionally, you can
206 view the help files here:
208 * [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
209 * [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
210 * [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
211 * [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
212 * [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
213 * [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
215 I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
216 a brief introduction to the more powerful configuration features micro offers.
220 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
222 You can use the [GitHub issue tracker](https://github.com/zyedidia/micro/issues)
223 to report bugs, ask questions, or suggest new features.
225 For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).