README.md 8.5 KB
Newer Older
Z
Zachary Yedidia 已提交
1
# ![Micro](./assets/logo.png)
Z
Zachary Yedidia 已提交
2

Z
Zachary Yedidia 已提交
3
[![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
4
[![Go Report Card](https://goreportcard.com/badge/github.com/zyedidia/micro)](https://goreportcard.com/report/github.com/zyedidia/micro)
Z
Zachary Yedidia 已提交
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)
Z
Zachary Yedidia 已提交
6
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/micro/blob/master/LICENSE)
E
Evan 已提交
7
[![Snap Status](https://build.snapcraft.io/badge/zyedidia/micro.svg)](https://build.snapcraft.io/user/zyedidia/micro)
Z
Zachary Yedidia 已提交
8

Z
Zachary Yedidia 已提交
9
Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
Z
Zachary Yedidia 已提交
10
of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now.
Z
Zachary Yedidia 已提交
11

12 13 14
As the name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use in a pinch, but micro also aims to be
enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).

Z
Zachary Yedidia 已提交
15 16
Here is a picture of micro editing its source code.

Z
Zachary Yedidia 已提交
17
![Screenshot](./assets/micro-solarized.png)
Z
Zachary Yedidia 已提交
18

Z
Zachary Yedidia 已提交
19
To see more screenshots of micro, showcasing all of the default colorschemes, see [here](http://zbyedidia.webfactional.com/micro/screenshots.html).
20

Z
Zachary Yedidia 已提交
21 22
You can also check out the website for Micro at https://micro-editor.github.io.

Z
Zachary Yedidia 已提交
23 24
# Features

Z
Zachary Yedidia 已提交
25 26
* Easy to use and to install
* No dependencies or external files are needed -- just the binary you can download further down the page
Z
Zachary Yedidia 已提交
27
* Multiple cursors
Z
Zachary Yedidia 已提交
28
* Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
Z
Zachary Yedidia 已提交
29
    * Keybindings can be rebound to your liking
Z
Zachary Yedidia 已提交
30 31
* Sane defaults
    * You shouldn't have to configure much out of the box (and it is extremely easy to configure)
Z
Zachary Yedidia 已提交
32
* Splits and tabs
Z
Zachary Yedidia 已提交
33
* Extremely good mouse support
Z
Zachary Yedidia 已提交
34
    * This means mouse dragging to create a selection, double click to select by word, and triple click to select by line
Z
Zachary Yedidia 已提交
35
* Cross platform (It should work on all the platforms Go runs on)
36
    * Note that while Windows is supported, there are still some bugs that need to be worked out
Z
Zachary Yedidia 已提交
37
* Plugin system (plugins are written in Lua)
Z
Zachary Yedidia 已提交
38
    * Micro has a built-in plugin manager to automatically install, remove, and update all your plugins
39
* Persistent undo
Z
Zachary Yedidia 已提交
40
* Automatic linting and error notifications
N
Nicolai 已提交
41
* Syntax highlighting (for over [90 languages](runtime/syntax)!)
Z
Zachary Yedidia 已提交
42
* Colorscheme support
Z
Zachary Yedidia 已提交
43
    * By default, micro comes with 16, 256, and true color themes.
Z
Zachary Yedidia 已提交
44
* True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
Z
Zachary Yedidia 已提交
45 46
* Snippets
    * The snippet plugin can be installed with `> plugin install snippets`
Z
Zachary Yedidia 已提交
47
* Copy and paste with the system clipboard
Z
Zachary Yedidia 已提交
48
* Small and simple
Z
Zachary Yedidia 已提交
49
* Easily configurable
Z
Zachary Yedidia 已提交
50
* Macros
Z
Zachary Yedidia 已提交
51
* Common editor things such as undo/redo, line numbers, Unicode support, softwrap...
Z
Zachary Yedidia 已提交
52

Z
Zachary Yedidia 已提交
53
Although not yet implemented, I hope to add more features such as autocompletion ([#174](https://github.com/zyedidia/micro/issues/174)) or a tree view ([#249](https://github.com/zyedidia/micro/issues/249)) in the future.
54

Z
Zachary Yedidia 已提交
55 56
# Installation

Z
Zachary Yedidia 已提交
57
To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
58

59
If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).
60

Z
Zachary Yedidia 已提交
61
### Prebuilt binaries
62

Z
Zachary Yedidia 已提交
63
All you need to install micro is one file, the binary itself. It's as simple as that!
64

Z
Zachary Yedidia 已提交
65
Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
Z
Zachary Yedidia 已提交
66

67 68
On that page you'll see the nightly release, which contains binaries for micro which are built every night,
and you'll see all the stable releases with the corresponding binaries.
Z
Zachary Yedidia 已提交
69

70
If you'd like to see more information after installing micro, run `micro -version`.
Z
Zachary Yedidia 已提交
71

72
### Package Managers
Z
Zachary Yedidia 已提交
73

74
You can install micro using Homebrew on Mac:
Z
Zachary Yedidia 已提交
75 76

```
77
brew install micro
Z
Zachary Yedidia 已提交
78 79
```

80
On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop):
81 82 83

```
choco install micro
Z
Zachary Yedidia 已提交
84 85
```

86
or
Z
Zachary Yedidia 已提交
87 88

```
89
scoop install micro
90 91
```

A
Alan Pope 已提交
92 93 94
On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)

```
Z
Zachary Yedidia 已提交
95
snap install micro --classic
A
Alan Pope 已提交
96 97
```

Z
Zachary Yedidia 已提交
98
### Building from source
Z
Zachary Yedidia 已提交
99

Z
Zachary Yedidia 已提交
100
If your operating system does not have a binary release, but does run Go, you can build from source.
101

102
Make sure that you have Go version 1.5 or greater (Go 1.4 will work if your version supports CGO) and that your `GOPATH` env variable is set (I recommand setting it to `~/go` if you don't have one).
103

Z
Zachary Yedidia 已提交
104
```
Z
Zachary Yedidia 已提交
105
go get -d github.com/zyedidia/micro/cmd/micro
Z
Zachary Yedidia 已提交
106
cd $GOPATH/src/github.com/zyedidia/micro
107 108 109
make install
```

Z
Zachary Yedidia 已提交
110
The binary will then be installed to `$GOPATH/bin` (or your `$GOBIN`).
111

Z
Zachary Yedidia 已提交
112 113
Please make sure that when you are working with micro's code, you are working on your `GOPATH`.

Z
Zachary Yedidia 已提交
114
You can install directly with `go get` (`go get -u github.com/zyedidia/micro/cmd/micro`) but this isn't recommended because it doesn't build micro with version information which is useful for the plugin manager.
Z
Zachary Yedidia 已提交
115

Z
Zachary Yedidia 已提交
116 117
### MacOS terminal

Z
Zachary Yedidia 已提交
118
If you are using MacOS, you should consider using [iTerm2](http://iterm2.com/) instead of the default Mac terminal. The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose `xterm defaults` under `Preferences->Profiles->Keys->Load Preset`. The newest versions also support true color.
Z
Zachary Yedidia 已提交
119

120
### Linux clipboard support
121

122
On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed.
C
Camille Scholtz 已提交
123 124

For Ubuntu:
125

126
```sh
C
Camille Scholtz 已提交
127
sudo apt-get install xclip
128 129
```

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

132 133 134 135
### Colors and syntax highlighting

If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
Z
Zachary Yedidia 已提交
136
by pressing CtrlE in micro and typing `set colorscheme simple`.
137

138
If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
139
to `xterm-256color`.
140 141 142 143

Many of the Windows terminals don't support more than 16 colors, which means
that micro's default colorscheme won't look very good. You can either set
the colorscheme to `simple`, or download a better terminal emulator, like
144
mintty.
145

146
### Plan9, Cygwin
Z
Zachary Yedidia 已提交
147 148 149

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
150
Plan9, and Cygwin (although this may change in the future). Micro also doesn't support NaCl (but NaCl is deprecated anyways).
Z
Zachary Yedidia 已提交
151

Z
Zachary Yedidia 已提交
152 153 154 155 156 157
# 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`:

158 159
```sh
ifconfig | micro
Z
Zachary Yedidia 已提交
160 161 162 163
```

You can move the cursor around with the arrow keys and mouse.

Z
Zachary Yedidia 已提交
164 165 166
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.
Z
Zachary Yedidia 已提交
167

168
# Documentation and Help
Z
Zachary Yedidia 已提交
169

170
Micro has a built-in help system which you can access by pressing `Ctrl-E` and typing `help`. Additionally, you can
Z
Zachary Yedidia 已提交
171 172
view the help files here:

Z
Zachary Yedidia 已提交
173 174 175 176 177 178
* [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
* [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
* [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
* [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
* [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
* [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
Z
Zachary Yedidia 已提交
179

180
I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
Z
Zachary Yedidia 已提交
181
a brief introduction to the more powerful configuration features micro offers.
182

Z
Zachary Yedidia 已提交
183
# Contributing
Z
Zachary Yedidia 已提交
184

Z
Zachary Yedidia 已提交
185
If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
186

Z
Bump  
Zachary Yedidia 已提交
187 188
You can use the [GitHub issue tracker](https://github.com/zyedidia/micro/issues)
to report bugs, ask questions, or suggest new features.
Z
Zachary Yedidia 已提交
189 190

For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).