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