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 Micro is devel-only for now because there is no released version.
  38
  39 ### OSX
  40
  41 If you are on OSX, you can install micro using Homebrew:
  42
  43 ```sh
  44 brew tap zyedidia/micro
  45 brew install --devel micro
  46 ```
  47
  48 ### Arch Linux
  49
  50 If you are on Arch Linux, you can install micro using the AUR:
  51
  52 ```sh
  53 wget https://aur.archlinux.org/cgit/aur.git/snapshot/micro-git.tar.gz
  54 cd micro-git
  55 makepkg -si
  56 ```
  57
  58 ### CRUX
  59
  60 If you are on CRUX, you can install micro using the 6c37-git repo:
  61
  62 ```sh
  63 git clone https://github.com/6c37/crux-ports-git
  64 cd crux-ports-git/micro
  65 # make sure you have go installed!
  66 pkgmk -i
  67 ```
  68
  69 ### Prebuilt binaries
  70
  71 Nightly binaries:
  72 * [Mac OS X](http://zbyedidia.webfactional.com/micro/binaries/micro-osx.tar.gz)
  73 * [Linux 64](http://zbyedidia.webfactional.com/micro/binaries/micro-linux64.tar.gz)
  74 * [Linux 32](http://zbyedidia.webfactional.com/micro/binaries/micro-linux32.tar.gz)
  75 * [Linux Arm](http://zbyedidia.webfactional.com/micro/binaries/micro-linux-arm.tar.gz)
  76 * [FreeBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd64.tar.gz)
  77 * [FreeBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd32.tar.gz)
  78 * [OpenBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd64.tar.gz)
  79 * [OpenBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd32.tar.gz)
  80 * [NetBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd64.tar.gz)
  81 * [NetBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd32.tar.gz)
  82 * [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip)
  83 * [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip)
  84
  85 To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
  86
  87 ### Building from source
  88
  89 Micro is made in Go so you must have Go installed on your system to build it.
  90
  91 Make sure that you have Go version 1.4 or greater.
  92
  93 You can simply `go get` it.
  94
  95 ```sh
  96 go get -u github.com/zyedidia/micro/cmd/micro
  97 ```
  98
  99 ### Clipboard support
 100
 101 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.
 102
 103 For Ubuntu:
 104
 105 ```sh
 106 sudo apt-get install xclip
 107 ```
 108
 109 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.
 110
 111 # Usage
 112
 113 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
 114
 115 Micro also supports creating buffers from `stdin`:
 116
 117 ```sh
 118 ifconfig | micro
 119 ```
 120
 121 You can move the cursor around with the arrow keys and mouse.
 122
 123 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
 124 to enable word selection, and triple click to enable line selection.
 125
 126 You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
 127 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
 128 with a version number defined.
 129
 130 ### Help text
 131
 132 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
 133 configuration options.
 134
 135 # Contributing
 136
 137 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.