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 # Features
  21
  22 * Easy to use and to install
  23 * No dependencies or external files are needed -- just the binary you can download further down the page
  24 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
  25     * Keybindings can be rebound to your liking
  26 * Sane defaults
  27     * You shouldn't have to configure much out of the box (and it is extremely easy to configure)
  28 * Splits and tabs
  29 * Extremely good mouse support
  30     * This means mouse dragging to create a selection, double click to select by word, and triple click to select by line
  31 * Cross platform (It should work on all the platforms Go runs on)
  32     * Note that while Windows is supported, there are still some bugs that need to be worked out
  33 * Plugin system (plugins are written in Lua)
  34 * Persistent undo
  35 * Automatic linting and error notifications
  36 * Syntax highlighting (for over [75 languages](runtime/syntax)!)
  37 * Colorscheme support
  38     * By default, micro comes with 16, 256, and true color themes.
  39 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
  40 * Copy and paste with the system clipboard
  41 * Small and simple
  42 * Easily configurable
  43 * Common editor things such as undo/redo, line numbers, unicode support...
  44
  45 Although not yet implemented, I hope to add more features such as autocompletion, and multiple cursors in the future.
  46
  47 # Installation
  48
  49 To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
  50
  51 If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro)
  52
  53 ### Prebuilt binaries
  54
  55 All you need to install micro is one file, the binary itself. It's as simple as that!
  56
  57 Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
  58
  59 On that page you'll see the nightly release, which contains binaries for micro which are built every night,
  60 and you'll see all the stable releases with the corresponding binaries.
  61
  62 If you'd like to see more information after installing micro, run `micro -version`.
  63
  64 ### Building from source
  65
  66 If your operating system does not have binary, but does run Go, you can build from source.
  67
  68 Make sure that you have Go version 1.5 or greater (Go 1.4 will work if your version supports CGO).
  69
  70 ```sh
  71 go get -u github.com/zyedidia/micro/...
  72 ```
  73
  74 ### Linux clipboard support
  75
  76 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.
  77
  78 For Ubuntu:
  79
  80 ```sh
  81 sudo apt-get install xclip
  82 ```
  83
  84 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.
  85
  86 ### Colors and syntax highlighting
  87
  88 If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
  89 you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
  90 by running `> set colorscheme simple`.
  91
  92 If you are using the default ubuntu terminal, to enable 256 make sure your `TERM` variable is set
  93 to `xterm-256color`.
  94
  95 Many of the Windows terminals don't support more than 16 colors, which means
  96 that micro's default colorscheme won't look very good. You can either set
  97 the colorscheme to `simple`, or download a better terminal emulator, like
  98 mintty.
  99
 100 ### Plan9, NaCl, Cygwin
 101
 102 Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
 103 means that micro is restricted to the platforms tcell supports. As a result, micro does not support
 104 Plan9, NaCl, and Cygwin (although this may change in the future).
 105
 106 # Usage
 107
 108 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
 109
 110 Micro also supports creating buffers from `stdin`:
 111
 112 ```sh
 113 ifconfig | micro
 114 ```
 115
 116 You can move the cursor around with the arrow keys and mouse.
 117
 118 You can also use the mouse to manipulate the text. Simply clicking and dragging
 119 will select text. You can also double click to enable word selection, and triple
 120 click to enable line selection.
 121
 122 # Documentation and Help
 123
 124 Micro has a built-in help system which you can access by pressing `CtrlE` and typing `help`. Additionally, you can
 125 view the help files online [here](https://github.com/zyedidia/micro/tree/master/runtime/help).
 126
 127 I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
 128 a brief introduction to the more powerful configuration features micro offers.
 129
 130 # Contributing
 131
 132 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
 133
 134 You can use the Github issue tracker to report bugs, ask questions, or suggest new features.