README.md

   1 # Micro
   2
   3 [![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)
   4
   5 [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
   6 [![Go Report Card](http://goreportcard.com/badge/zyedidia/micro)](http://goreportcard.com/report/zyedidia/micro)
   7 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/micro/blob/master/LICENSE)
   8
   9 > Micro is very much a work in progress
  10
  11 Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
  12 of modern terminals.
  13
  14 Here is a picture of micro editing its source code.
  15
  16 ![Screenshot](./screenshot.png)
  17
  18 # Features
  19
  20 * Easy to use
  21 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
  22 * Extremely good mouse support
  23 * Cross platform
  24 * Syntax highlighting (in over [75 languages](runtime/syntax)!)
  25 * Colorscheme support
  26 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
  27 * Search and replace
  28 * Undo and redo
  29 * Unicode support
  30 * Copy and paste with the system clipboard
  31 * Small and simple
  32 * Configurable
  33
  34 If you'd like to see what has been implemented, and what I plan on implementing soon-ish, see the [todo list](todolist.md)
  35
  36 # Installation
  37
  38 ### Homebrew
  39
  40 If you are on Mac, you can install micro using Homebrew:
  41
  42 ```
  43 brew tap zyedidia/micro
  44 brew install --devel micro
  45 ```
  46
  47 Micro is devel-only for now because there is no released version.
  48
  49 ### Prebuilt binaries
  50 | Version | Mac | Linux 64 | Linux 32 | Linux Arm | Windows 64 | Windows 32 |
  51 | ------- | --- |---|---|---|---|---|
  52 | 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)
  53
  54 To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
  55
  56 ### Building from source
  57
  58 Micro is made in Go so you must have Go installed on your system to build it.
  59
  60 You can simply `go get` it.
  61
  62 ```
  63 go get -u github.com/zyedidia/micro/cmd/micro
  64 ```
  65
  66 ### Clipboard support
  67
  68 On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
  69
  70 ```
  71 $ sudo apt-get install xclip
  72 ```
  73
  74 # Usage
  75
  76 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
  77
  78 Micro also supports creating buffers from `stdin`:
  79
  80 ```
  81 $ ifconfig | micro
  82 ```
  83
  84 You can move the cursor around with the arrow keys and mouse.
  85
  86 #### Keybindings
  87
  88 * Ctrl-q:   Quit
  89 * Ctrl-s:   Save
  90 * Ctrl-o:   Open file
  91 * Ctrl-z:   Undo
  92 * Ctrl-y:   Redo
  93 * Ctrl-f:   Find
  94 * Ctrl-n:   Find next
  95 * Ctrl-p:   Find previous
  96 * Ctrl-a:   Select all
  97 * Ctrl-c:   Copy
  98 * Ctrl-x:   Cut
  99 * Ctrl-v:   Paste
 100 * Ctrl-g:   Open help
 101 * Ctrl-u:   Half page up
 102 * Ctrl-d:   Half page down
 103 * PageUp:   Page up
 104 * PageDown: Page down
 105 * Home:     Go to beginning
 106 * End:      Go to end
 107 * Ctrl-e:   Execute a command
 108
 109 You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click
 110 to enable word selection, and triple click to enable line selection.
 111
 112 You can also run `$ micro -version` to get the version number. Since there is no release, this just gives you the
 113 commit hash. The version is unknown if you built with `go get`, instead use `make install` or `make` to get a binary
 114 with a version number defined.
 115
 116 # Configuration
 117
 118 Configuration directory:
 119
 120 Micro uses the `$XDG_CONFIG_HOME/micro` as the configuration directory. As per the XDG spec,
 121 if `$XDG_CONFIG_HOME` is not set, `~/.config/micro` is used as the config directory.
 122
 123 At this point, there isn't much you can configure.
 124 Micro has a few options which you can set:
 125
 126 * colorscheme
 127 * tabsize
 128 * syntax
 129 * tabsToSpaces
 130
 131 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.
 132
 133 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.
 134
 135 The tabsToSpaces option is on or off. It specifies whether to use spaces instead of tabs or not. The default is off.
 136
 137 The colorscheme can be selected from all the files in the `~/.config/micro/colorschemes/` directory. Micro comes by default with three colorschemes:
 138
 139 * default: this is the default colorscheme.
 140 * solarized: this is the solarized colorscheme (used in the screenshot). You should have the solarized color palette in your terminal to use it.
 141 * 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.
 142
 143 These are embedded in the Go binary, but to see their source code, look [here](./runtime/colorschemes)
 144
 145 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
 146 for you. If you'd like to take your configuration with you to another machine, simply copy the `settings.json` to the other machine.
 147
 148 # Contributing
 149
 150 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.