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
  20 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
  21 * Extremely good mouse support
  22 * Cross platform
  23 * Syntax highlighting (in over [75 languages](runtime/syntax)!)
  24 * Colorscheme support
  25 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
  26 * Search and replace
  27 * Sane defaults
  28 * Plugin system (plugins are written in Lua)
  29 * Undo and redo
  30 * Unicode support
  31 * Copy and paste with the system clipboard
  32 * Small and simple
  33 * Easily configurable
  34
  35 # Installation
  36
  37 ### Homebrew
  38
  39 If you are on Mac, you can install micro using Homebrew:
  40
  41 ```
  42 brew tap zyedidia/micro
  43 brew install --devel micro
  44 ```
  45
  46 Micro is devel-only for now because there is no released version.
  47
  48 ### Prebuilt binaries
  49 | Version | Mac | Linux 64 | Linux 32 | Linux Arm | Windows 64 | Windows 32 |
  50 | ------- | --- |---|---|---|---|---|
  51 | Nightly Binaries | [Mac OS X](http://zbyedidia.webfactional.com/micro/binaries/micro-osx.tar.gz) | [Linux 64](http://zbyedidia.webfactional.com/micro/binaries/micro-linux64.tar.gz) | [Linux 32](http://zbyedidia.webfactional.com/micro/binaries/micro-linux32.tar.gz) | [Linux Arm](http://zbyedidia.webfactional.com/micro/binaries/micro-linux-arm.tar.gz) | [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip) | [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip)
  52
  53 To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
  54
  55 ### Building from source
  56
  57 Micro is made in Go so you must have Go installed on your system to build it.
  58
  59 Make sure that you have Go version 1.4 or greater.
  60
  61 You can simply `go get` it.
  62
  63 ```
  64 go get -u github.com/zyedidia/micro/cmd/micro
  65 ```
  66
  67 ### Clipboard support
  68
  69 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
  70
  71 ```
  72 $ sudo apt-get install xclip
  73 ```
  74
  75 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.
  76
  77 # Usage
  78
  79 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
  80
  81 Micro also supports creating buffers from `stdin`:
  82
  83 ```
  84 $ ifconfig | micro
  85 ```
  86
  87 You can move the cursor around with the arrow keys and mouse.
  88
  89 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
  90 to enable word selection, and triple click to enable line selection.
  91
  92 You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
  93 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
  94 with a version number defined.
  95
  96 #### Help text
  97
  98 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
  99 configuration options.
 100
 101 # Contributing
 102
 103 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.