[](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
* Colorscheme support
* True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
* Search and replace
+* Sane defaults
* Undo and redo
* Unicode support
* Copy and paste with the system clipboard
Micro is devel-only for now because there is no released version.
### Prebuilt binaries
-
-| Download |
-| --- |
-| [Mac OS X](http://zbyedidia.webfactional.com/micro/binaries/micro-osx.tar.gz) |
-| [64 bit Linux](http://zbyedidia.webfactional.com/micro/binaries/micro-linux64.tar.gz) |
-| [32 bit Linux](http://zbyedidia.webfactional.com/micro/binaries/micro-linux32.tar.gz) |
-| [Arm Linux](http://zbyedidia.webfactional.com/micro/binaries/micro-linux-arm.tar.gz) |
-
-Once you have downloaded the file, you can install the runtime files by running `./install.sh`
-in the directory you downloaded. This will place all the runtime files in `~/.micro`.
+| Version | Mac | Linux 64 | Linux 32 | Linux Arm | Windows 64 | Windows 32 |
+| ------- | --- |---|---|---|---|---|
+| 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)
To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
### Building from source
-Micro is made in Go so you must have Go installed on your system to build it, and make sure your `GOPATH` is set.
+Micro is made in Go so you must have Go installed on your system to build it.
-```
-$ git clone https://github.com/zyedidia/micro
-$ cd micro
-$ make
-```
+Make sure that you have Go version 1.4 or greater.
-This will build micro and put the binary in the current directory. It will also install syntax highlighting files to `~/.micro/syntax`.
+You can simply `go get` it.
-Alternatively you can use `make install` instead of `make` if you want the binary to be added to you `GOBIN` (make sure that it is set).
+```
+go get -u github.com/zyedidia/micro/cmd/micro
+```
### Clipboard support
-Linux, Unix requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
+On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
```
-$ sudo aptitude install xclip
+$ 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.
You can move the cursor around with the arrow keys and mouse.
-#### Keybindings
-
-* Ctrl-q: Quit
-* Ctrl-s: Save
-* Ctrl-o: Open file
-* Ctrl-z: Undo
-* Ctrl-y: Redo
-* Ctrl-f: Find
-* Ctrl-n: Find next
-* Ctrl-p: Find previous
-* Ctrl-a: Select all
-* Ctrl-c: Copy
-* Ctrl-x: Cut
-* Ctrl-v: Paste
-* Ctrl-h: Open help
-* Ctrl-u: Half page up
-* Ctrl-d: Half page down
-* PageUp: Page up
-* PageDown: Page down
-* Ctrl-e: Execute a command
-
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](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
+configuration options.
+
# Configuration
+Configuration directory:
+
+Micro uses the `$XDG_CONFIG_HOME/micro` as the configuration directory. As per the XDG spec,
+if `$XDG_CONFIG_HOME` is not set, `~/.config/micro` is used as the config directory.
+
At this point, there isn't much you can configure.
Micro has a few options which you can set:
* colorscheme
* tabsize
* syntax
+* tabsToSpaces
+
+To set an option run Ctrl-e to execute a command, and type `set option value`, so to set the tabsize to 8 it would be `set tabsize 8`. The default is 4.
-To set an option run Ctrl-e to execute a command, and type `set option value`, so to set the tabsize to 8 it would be `set tabsize 8`.
+The syntax option can simply be on or off, so for example to turn syntax highlighting off, run `set syntax off`. The default is on.
-The syntax option can simply be on or off, so for example to turn syntax highlighting off, run `set syntax off`.
+The tabsToSpaces option is on or off. It specifies whether to use spaces instead of tabs or not. The default is off.
-The colorscheme can be selected from all the files in the `~/.micro/colorschemes/` directory. Micro comes by default with three colorschemes:
+The colorscheme can be selected from all the files in the `~/.config/micro/colorschemes/` directory. Micro comes by default with three colorschemes:
-* default: this is the default colorscheme
-* solarized: this is the solarized colorscheme (used in the screenshot). You should have the solarized color palette in your terminal to use it
+* default: this is the default colorscheme.
+* solarized: this is the solarized colorscheme (used in the screenshot). You should have the solarized color palette in your terminal to use it.
* solarized-tc: this is the solarized colorscheme for true color, just make sure your terminal supports true color before using it and that the `MICRO_TRUECOLOR` environment variable is set to 1 before starting micro.
-Any option you set in the editor will be saved to the file `~/.micro/settings.json` so, in effect, your configuration file will be created
+These are embedded in the Go binary, but to see their source code, look [here](./runtime/colorschemes)
+
+Any option you set in the editor will be saved to the file `~/.config/micro/settings.json` so, in effect, your configuration file will be created
for you. If you'd like to take your configuration with you to another machine, simply copy the `settings.json` to the other machine.
# Contributing
projects / micro.git / blobdiff