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