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