README.md

   1 # Micro
   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)
   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 very much a work in progress
   9
  10 Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
  11 of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now.
  12
  13 Here is a picture of micro editing its source code.
  14
  15 ![Screenshot](./screenshot.png)
  16
  17 # Features
  18
  19 * Easy to use and to install
  20 * No dependencies or external files are needed -- just the binary you can download further down the page
  21 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
  22     * Keybindings can be rebound to your liking
  23 * Extremely good mouse support
  24 * Cross platform (It should work on all the platforms Go runs on)
  25 * Plugin system (plugins are written in Lua)
  26 * Syntax highlighting (for over [75 languages](runtime/syntax)!)
  27 * Colorscheme support
  28 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
  29 * Sane defaults
  30 * Copy and paste with the system clipboard
  31 * Small and simple
  32 * Easily configurable
  33 * Common editor things such as undo/redo, line numbers, unicode support...
  34
  35 # Installation
  36
  37 This section gives instructions for how to simply install micro using the prebuilt binaries, or building from source.
  38
  39 You can also install micro with a few package managers (on OSX, Arch Linux, and CRUX).
  40 See the [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro) for details.
  41
  42 ### Prebuilt binaries
  43
  44 To easily install micro on any of the operating systems listed below, just download the tar file,
  45 extract it, and run the binary inside. It's as simple as that!
  46
  47 Micro has no released version, instead these binaries are compiled every night and you can find the
  48 commit it was compiled with by running `micro -version`.
  49
  50 [You can find the binaries in the nightly build release](https://github.com/zyedidia/micro/releases/tag/nightly)
  51
  52 To run the micro binary just run `./micro` (you probably want to place the binary on your `$PATH` for ease of use).
  53
  54 ### Building from source
  55
  56 Make sure that you have Go version 1.4 or greater.
  57
  58 ```sh
  59 go get -u github.com/zyedidia/micro/...
  60 ```
  61
  62 ### Clipboard support
  63
  64 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.
  65
  66 For Ubuntu:
  67
  68 ```sh
  69 sudo apt-get install xclip
  70 ```
  71
  72 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.
  73
  74 # Usage
  75
  76 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
  77
  78 Micro also supports creating buffers from `stdin`:
  79
  80 ```sh
  81 ifconfig | micro
  82 ```
  83
  84 You can move the cursor around with the arrow keys and mouse.
  85
  86 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
  87 to enable word selection, and triple click to enable line selection.
  88
  89 You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
  90 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
  91 with a version number defined.
  92
  93 ### Help text
  94
  95 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
  96 configuration options.
  97
  98 # Contributing
  99
 100 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.