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 # Table of Contents
  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)
  33 - [Usage](#usage)
  34 - [Documentation and Help](#documentation-and-help)
  35 - [Contributing](#contributing)
  36
  37 - - -
  38
  39 # Features
  40
  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
  43 * Multiple cursors
  44 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
  45     * Keybindings can be rebound to your liking
  46 * Sane defaults
  47     * You shouldn't have to configure much out of the box (and it is extremely easy to configure)
  48 * Splits and tabs
  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
  56 * Persistent undo
  57 * Automatic linting and error notifications
  58 * Syntax highlighting (for over [90 languages](runtime/syntax)!)
  59 * Colorscheme support
  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)
  62 * Snippets
  63     * The snippet plugin can be installed with `> plugin install snippets`
  64 * Copy and paste with the system clipboard
  65 * Small and simple
  66 * Easily configurable
  67 * Macros
  68 * Common editor things such as undo/redo, line numbers, Unicode support, softwrap...
  69
  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.
  71
  72 # Installation
  73
  74 To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
  75
  76 If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).
  77
  78 ### Prebuilt binaries
  79
  80 All you need to install micro is one file, the binary itself. It's as simple as that!
  81
  82 Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
  83
  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.
  86
  87 If you'd like to see more information after installing micro, run `micro -version`.
  88
  89 ### Installation script
  90
  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)).
  92
  93 Then you can easily install micro:
  94
  95     $ curl https://getmic.ro | bash
  96
  97 The script will install the micro binary to the current directory.
  98
  99 See the [Github page](https://github.com/benweissmann/getmic.ro) for more information.
 100
 101 ### Package managers
 102
 103 You can install micro using Homebrew on Mac:
 104
 105 ```
 106 brew install micro
 107 ```
 108
 109 On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop):
 110
 111 ```
 112 choco install micro
 113 ```
 114
 115 or
 116
 117 ```
 118 scoop install micro
 119 ```
 120
 121 On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)
 122
 123 ```
 124 snap install micro --classic
 125 ```
 126
 127 On OpenBSD, micro is available in the ports tree. It is also available as a binary package.
 128
 129 ```
 130 pkg_add -v micro
 131 ```
 132
 133 ### Building from source
 134
 135 If your operating system does not have a binary release, but does run Go, you can build from source.
 136
 137 Make sure that you have Go version 1.11 or greater and Go modules are enabled.
 138
 139 ```
 140 git clone https://github.com/zyedidia/micro
 141 cd micro
 142 make build
 143 sudo mv micro /usr/local/bin # optional
 144 ```
 145
 146 The binary will be placed in the current directory and can be moved to
 147 anywhere you like (for example `/usr/local/bin`).
 148
 149 The command `make install` will install the binary to `$GOPATH/bin` or `$GOBIN`.
 150
 151 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.
 152
 153 ### MacOS terminal
 154
 155 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.
 156
 157 ### Linux clipboard support
 158
 159 On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed.
 160
 161 For Ubuntu:
 162
 163 ```sh
 164 sudo apt-get install xclip
 165 ```
 166
 167 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.
 168
 169 ### Colors and syntax highlighting
 170
 171 If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
 172 you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
 173 by pressing CtrlE in micro and typing `set colorscheme simple`.
 174
 175 If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
 176 to `xterm-256color`.
 177
 178 Many of the Windows terminals don't support more than 16 colors, which means
 179 that micro's default colorscheme won't look very good. You can either set
 180 the colorscheme to `simple`, or download a better terminal emulator, like
 181 mintty.
 182
 183 ### Plan9, Cygwin
 184
 185 Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
 186 means that micro is restricted to the platforms tcell supports. As a result, micro does not support
 187 Plan9, and Cygwin (although this may change in the future). Micro also doesn't support NaCl (but NaCl is deprecated anyways).
 188
 189 # Usage
 190
 191 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
 192
 193 Micro also supports creating buffers from `stdin`:
 194
 195 ```sh
 196 ifconfig | micro
 197 ```
 198
 199 You can move the cursor around with the arrow keys and mouse.
 200
 201 You can also use the mouse to manipulate the text. Simply clicking and dragging
 202 will select text. You can also double click to enable word selection, and triple
 203 click to enable line selection.
 204
 205 # Documentation and Help
 206
 207 Micro has a built-in help system which you can access by pressing `Ctrl-E` and typing `help`. Additionally, you can
 208 view the help files here:
 209
 210 * [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
 211 * [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
 212 * [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
 213 * [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
 214 * [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
 215 * [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
 216
 217 I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
 218 a brief introduction to the more powerful configuration features micro offers.
 219
 220 # Contributing
 221
 222 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
 223
 224 You can use the [GitHub issue tracker](https://github.com/zyedidia/micro/issues)
 225 to report bugs, ask questions, or suggest new features.
 226
 227 For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).