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.
  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 * Configurable
  34
  35 If you'd like to see what has been implemented, and what I plan on implementing soon-ish, see the [todo list](todolist.md)
  36
  37 # Installation
  38
  39 ### Homebrew
  40
  41 If you are on Mac, you can install micro using Homebrew:
  42
  43 ```
  44 brew tap zyedidia/micro
  45 brew install --devel micro
  46 ```
  47
  48 Micro is devel-only for now because there is no released version.
  49
  50 ### Prebuilt binaries
  51 | Version | Mac | Linux 64 | Linux 32 | Linux Arm | Windows 64 | Windows 32 |
  52 | ------- | --- |---|---|---|---|---|
  53 | 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)
  54
  55 To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
  56
  57 ### Building from source
  58
  59 Micro is made in Go so you must have Go installed on your system to build it.
  60
  61 Make sure that you have Go version 1.4 or greater.
  62
  63 You can simply `go get` it.
  64
  65 ```
  66 go get -u github.com/zyedidia/micro/cmd/micro
  67 ```
  68
  69 ### Clipboard support
  70
  71 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
  72
  73 ```
  74 $ sudo apt-get install xclip
  75 ```
  76
  77 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.
  78
  79 # Usage
  80
  81 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
  82
  83 Micro also supports creating buffers from `stdin`:
  84
  85 ```
  86 $ ifconfig | micro
  87 ```
  88
  89 You can move the cursor around with the arrow keys and mouse.
  90
  91 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
  92 to enable word selection, and triple click to enable line selection.
  93
  94 You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
  95 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
  96 with a version number defined.
  97
  98 #### Help text
  99
 100 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
 101 configuration options.
 102
 103 # Contributing
 104
 105 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.