README.md

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