mirror of https://github.com/zyedidia/micro synced 2024-11-05 17:41:24 +00:00

No description

Find a file

Zachary Yedidia 7adcb13c08 Add support for user-created commands Plugins can now create their own commands using the `MakeCommand` function. Plugins can also now create their own keybindings with the `BindKey` function. See the go plugin for an example of `MakeCommand`.		2016-05-30 13:38:50 -04:00
cmd/micro	Add support for user-created commands	2016-05-30 13:38:50 -04:00
runtime	Add support for user-created commands	2016-05-30 13:38:50 -04:00
tools	Add -version option	2016-04-19 13:40:30 -04:00
.gitignore	ignore binary explicitly	2016-04-23 00:59:52 +00:00
.travis.yml	Fix travis	2016-03-25 15:04:24 -04:00
LICENSE	Move license to LICENSE	2016-03-18 21:41:26 -04:00
Makefile	Change selection color in solarized colorscheme	2016-04-30 15:32:33 -04:00
README.md	Update readme	2016-05-29 18:20:43 -04:00
screenshot.png	Update screenshot and status line	2016-05-03 18:54:01 -04:00
todolist.md	Add persistent undo as the option	2016-05-29 11:02:56 -04:00

README.md

Micro

Micro is very much 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
Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
Extremely good mouse support
Cross platform
Syntax highlighting (in over 75 languages!)
Colorscheme support
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

Installation

This section gives instructions for how to simply install micro using the prebuilt binaries, or building from source.

You can also install micro with a few package managers (on OSX, Arch Linux, and CRUX). See the wiki page for details.

Prebuilt binaries

To easily install micro on any of the operating systems listed below, just download the tar file, extract it, and run the binary inside. It's as simple as that!

Micro has no released version, instead these binaries are compiled every night and you can find the commit it was compiled with by running micro -version.

Nightly binaries:

To run the micro binary just run ./bin/micro (you probably want to place the binary on your $PATH for ease of use).

Building from source

Make sure that you have Go version 1.4 or greater.

go get -u github.com/zyedidia/micro/cmd/micro

Clipboard support

On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.

For Ubuntu:

sudo apt-get install xclip

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.

Usage

Once you have built the editor, simply start it by running micro path/to/file.txt or simply micro to open an empty buffer.

Micro also supports creating buffers from stdin:

ifconfig | micro

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 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.

Help text

See the help text for information about keybindings, editor commands, colorschemes and configuration options.

Contributing

If you find any bugs, please report them! I am also happy to accept pull requests from anyone.