README.md

   1 # ![Micro](./assets/logo.png)
   2
   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)
   8
   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.
  11
  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).
  14
  15 Here is a picture of micro editing its source code.
  16
  17 ![Screenshot](./assets/micro-solarized.png)
  18
  19 To see more screenshots of micro, showcasing all of the default colorschemes, see [here](http://zbyedidia.webfactional.com/micro/screenshots.html).
  20
  21 You can also check out the website for Micro at https://micro-editor.github.io.
  22
  23 # Features
  24
  25 * Easy to use and to install
  26 * No dependencies or external files are needed -- just the binary you can download further down the page
  27 * Multiple cursors
  28 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
  29     * Keybindings can be rebound to your liking
  30 * Sane defaults
  31     * You shouldn't have to configure much out of the box (and it is extremely easy to configure)
  32 * Splits and tabs
  33 * Nano-like menu to help you remember the keybindings
  34 * Extremely good mouse support
  35     * This means mouse dragging to create a selection, double click to select by word, and triple click to select by line
  36 * Cross platform (It should work on all the platforms Go runs on)
  37     * Note that while Windows is supported, there are still some bugs that need to be worked out
  38 * Plugin system (plugins are written in Lua)
  39     * Micro has a built-in plugin manager to automatically install, remove, and update all your plugins
  40 * Persistent undo
  41 * Automatic linting and error notifications
  42 * Syntax highlighting (for over [90 languages](runtime/syntax)!)
  43 * Colorscheme support
  44     * By default, micro comes with 16, 256, and true color themes.
  45 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
  46 * Snippets
  47     * The snippet plugin can be installed with `> plugin install snippets`
  48 * Copy and paste with the system clipboard
  49 * Small and simple
  50 * Easily configurable
  51 * Macros
  52 * Common editor things such as undo/redo, line numbers, Unicode support, softwrap...
  53
  54 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.
  55
  56 # Installation
  57
  58 To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
  59
  60 If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).
  61
  62 ### Prebuilt binaries
  63
  64 All you need to install micro is one file, the binary itself. It's as simple as that!
  65
  66 Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
  67
  68 On that page you'll see the nightly release, which contains binaries for micro which are built every night,
  69 and you'll see all the stable releases with the corresponding binaries.
  70
  71 If you'd like to see more information after installing micro, run `micro -version`.
  72
  73 ### Installation script
  74
  75 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)).
  76
  77 Then you can easily install micro:
  78
  79     $ curl https://getmic.ro | bash
  80
  81 The script will install the micro binary to the current directory.
  82
  83 See the [Github page](https://github.com/benweissmann/getmic.ro) for more information.
  84
  85 ### Package managers
  86
  87 You can install micro using Homebrew on Mac:
  88
  89 ```
  90 brew install micro
  91 ```
  92
  93 On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop):
  94
  95 ```
  96 choco install micro
  97 ```
  98
  99 or
 100
 101 ```
 102 scoop install micro
 103 ```
 104
 105 On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)
 106
 107 ```
 108 snap install micro --classic
 109 ```
 110
 111 On OpenBSD, micro is available in the ports tree. It is also available as a binary package.
 112
 113 ```
 114 pkg_add -v micro
 115 ```
 116
 117 ### Building from source
 118
 119 If your operating system does not have a binary release, but does run Go, you can build from source.
 120
 121 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).
 122
 123 ```
 124 go get -d github.com/zyedidia/micro/cmd/micro
 125 cd $GOPATH/src/github.com/zyedidia/micro
 126 make install
 127 ```
 128
 129 The binary will then be installed to `$GOPATH/bin` (or your `$GOBIN`).
 130
 131 Please make sure that when you are working with micro's code, you are working on your `GOPATH`.
 132
 133 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.
 134
 135 ### MacOS terminal
 136
 137 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.
 138
 139 ### Linux clipboard support
 140
 141 On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed.
 142
 143 For Ubuntu:
 144
 145 ```sh
 146 sudo apt-get install xclip
 147 ```
 148
 149 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.
 150
 151 ### Colors and syntax highlighting
 152
 153 If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
 154 you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
 155 by pressing CtrlE in micro and typing `set colorscheme simple`.
 156
 157 If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
 158 to `xterm-256color`.
 159
 160 Many of the Windows terminals don't support more than 16 colors, which means
 161 that micro's default colorscheme won't look very good. You can either set
 162 the colorscheme to `simple`, or download a better terminal emulator, like
 163 mintty.
 164
 165 ### Plan9, Cygwin
 166
 167 Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
 168 means that micro is restricted to the platforms tcell supports. As a result, micro does not support
 169 Plan9, and Cygwin (although this may change in the future). Micro also doesn't support NaCl (but NaCl is deprecated anyways).
 170
 171 # Usage
 172
 173 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
 174
 175 Micro also supports creating buffers from `stdin`:
 176
 177 ```sh
 178 ifconfig | micro
 179 ```
 180
 181 You can move the cursor around with the arrow keys and mouse.
 182
 183 You can also use the mouse to manipulate the text. Simply clicking and dragging
 184 will select text. You can also double click to enable word selection, and triple
 185 click to enable line selection.
 186
 187 # Documentation and Help
 188
 189 Micro has a built-in help system which you can access by pressing `Ctrl-E` and typing `help`. Additionally, you can
 190 view the help files here:
 191
 192 * [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
 193 * [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
 194 * [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
 195 * [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
 196 * [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
 197 * [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
 198
 199 I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
 200 a brief introduction to the more powerful configuration features micro offers.
 201
 202 # Contributing
 203
 204 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
 205
 206 You can use the [GitHub issue tracker](https://github.com/zyedidia/micro/issues)
 207 to report bugs, ask questions, or suggest new features.
 208
 209 For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).