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](http://goreportcard.com/badge/zyedidia/micro)](http://goreportcard.com/report/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 Nightly binaries:
  51 * [Mac OS X](http://zbyedidia.webfactional.com/micro/binaries/micro-osx.tar.gz)
  52 * [Linux 64](http://zbyedidia.webfactional.com/micro/binaries/micro-linux64.tar.gz)
  53 * [Linux 32](http://zbyedidia.webfactional.com/micro/binaries/micro-linux32.tar.gz)
  54 * [Linux Arm](http://zbyedidia.webfactional.com/micro/binaries/micro-linux-arm.tar.gz)
  55 * [FreeBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd64.tar.gz)
  56 * [FreeBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd32.tar.gz)
  57 * [OpenBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd64.tar.gz)
  58 * [OpenBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd32.tar.gz)
  59 * [NetBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd64.tar.gz)
  60 * [NetBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd32.tar.gz)
  61 * [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip)
  62 * [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip)
  63
  64 To run the micro binary just run `./micro` (you probably want to place the binary on your `$PATH` for ease of use).
  65
  66 ### Building from source
  67
  68 Make sure that you have Go version 1.4 or greater.
  69
  70 ```sh
  71 go get -u github.com/zyedidia/micro/...
  72 ```
  73
  74 ### 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 # Usage
  87
  88 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
  89
  90 Micro also supports creating buffers from `stdin`:
  91
  92 ```sh
  93 ifconfig | micro
  94 ```
  95
  96 You can move the cursor around with the arrow keys and mouse.
  97
  98 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
  99 to enable word selection, and triple click to enable line selection.
 100
 101 You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
 102 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
 103 with a version number defined.
 104
 105 ### Help text
 106
 107 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
 108 configuration options.
 109
 110 # Contributing
 111
 112 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.