-# Micro
+
[](https://travis-ci.org/zyedidia/micro)
-[](http://goreportcard.com/report/zyedidia/micro)
+
[](https://gitter.im/zyedidia/micro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/zyedidia/micro/blob/master/LICENSE)
-> Micro is very much a work in progress
+> Micro is still a work in progress
Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now.
Here is a picture of micro editing its source code.
-
+
# Features
-* Easy to use
+* Easy to use and to install
+* No dependencies or external files are needed -- just the binary you can download further down the page
* Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
+ * Keybindings can be rebound to your liking
+* Sane defaults
+ * You shouldn't have to configure much out of the box (and it is extremely easy to configure)
* Extremely good mouse support
-* Cross platform
-* Syntax highlighting (in over [75 languages](runtime/syntax)!)
+ * This means mouse dragging to create a selection, double click to select by word, and triple click to select by line
+* Cross platform (It should work on all the platforms Go runs on)
+* Plugin system (plugins are written in Lua)
+* Automatic linting and error notifications
+* Syntax highlighting (for over [75 languages](runtime/syntax)!)
* Colorscheme support
+ * By default, micro comes with 16, 256, and true color themes.
* True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
-* Search and replace
-* Sane defaults
-* Plugin system (plugins are written in Lua)
-* Undo and redo
-* Unicode support
* Copy and paste with the system clipboard
* Small and simple
* Easily configurable
+* Common editor things such as undo/redo, line numbers, unicode support...
# Installation
-Micro is devel-only for now because there is no released version.
-
-### OSX
-
-If you are on OSX, you can install micro using Homebrew:
-
-```sh
-brew tap zyedidia/micro
-brew install --devel micro
-```
-
-### Arch Linux
+To install micro, you can download a prebuilt binary, or you can build it from source.
-If you are on Arch Linux, you can install micro using the AUR:
+You can also install micro with a few package managers (on OSX, Arch Linux, and CRUX).
+See this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro) for details.
-```sh
-wget https://aur.archlinux.org/cgit/aur.git/snapshot/micro-git.tar.gz
-cd micro-git
-makepkg -si
-```
+Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
+means that micro is restricted to the platforms tcell supports. As a result, micro does not support
+Plan9, NaCl, and Cygwin (although this may change in the future).
-### CRUX
+### Prebuilt binaries
-If you are on CRUX, you can install micro using the 6c37-git repo:
+All you need to install micro is one file, the binary itself. It's as simple as that!
-```sh
-git clone https://github.com/6c37/crux-ports-git
-cd crux-ports-git/micro
-# make sure you have go installed!
-pkgmk -i
-```
+You can download the correct binary for your operating system from the list in the [nightly build release](https://github.com/zyedidia/micro/releases/tag/nightly).
-### Prebuilt binaries
+Micro has no released version, instead these binaries are compiled every night and you can find the
+commit they were compiled with by running `micro -version`.
-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)
-* [FreeBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd64.tar.gz)
-* [FreeBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd32.tar.gz)
-* [OpenBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd64.tar.gz)
-* [OpenBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd32.tar.gz)
-* [NetBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd64.tar.gz)
-* [NetBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd32.tar.gz)
-* [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip)
-* [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip)
-
-To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
+If your operating system does not have binary, but does run Go, you can build from source.
### Building from source
-Micro is made in Go so you must have Go installed on your system to build it.
-
-Make sure that you have Go version 1.4 or greater.
-
-You can simply `go get` it.
+Make sure that you have Go version 1.5 or greater (Go 1.4 will work for the systems like support CGO then).
```sh
-go get -u github.com/zyedidia/micro/cmd/micro
+go get -u github.com/zyedidia/micro/...
```
### Clipboard support
You can move the cursor around with the arrow keys and mouse.
-You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
-to enable word selection, and triple click to enable line selection.
+You can also use the mouse to manipulate the text. Simply clicking and dragging
+will select text. You can also double click to enable word selection, and triple
+click to enable line selection.
-You can run `$ micro -version` to get the version number. Since there is no release, this just gives you the
-commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
-with a version number defined.
+# Documentation and Help
-### Help text
-
-See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
-configuration options.
+Micro has a built-in help system which you can access by pressing `CtrlE` and typing `help`. Additionally, you can
+view the help files online [here](https://github.com/zyedidia/micro/tree/master/runtime/help).
# Contributing
If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
+
+You can use the Github issue tracker to report bugs, ask questions, or suggest new features.
projects / micro.git / blobdiff