X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=66139bc219dbcaa3c47779d983bfb2ae01a54245;hb=f56621a4bd469c09f31e7036da47d15b881ee89d;hp=091626b83970c8f0c86eb20052b4590dc1588982;hpb=8656335da4584a1a900d18a28eb47a4459b19c7f;p=micro.git diff --git a/README.md b/README.md index 091626b8..1dfb70a1 100644 --- a/README.md +++ b/README.md @@ -1,138 +1,225 @@ -# Micro +# ![Micro](./assets/logo.png) [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro) -[![Go Report Card](http://goreportcard.com/badge/zyedidia/micro)](http://goreportcard.com/report/zyedidia/micro) +[![Go Report Card](https://goreportcard.com/badge/github.com/zyedidia/micro)](https://goreportcard.com/report/github.com/zyedidia/micro) +[![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) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/micro/blob/master/LICENSE) - -> Micro is very much a work in progress +[![Snap Status](https://build.snapcraft.io/badge/zyedidia/micro.svg)](https://build.snapcraft.io/user/zyedidia/micro) 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. +of modern terminals. It comes as one single, batteries-included, static binary with no dependencies, and you can download and use it right now. + +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). Here is a picture of micro editing its source code. -![Screenshot](./screenshot.png) +![Screenshot](./assets/micro-solarized.png) + +To see more screenshots of micro, showcasing all of the default colorschemes, see [here](http://zbyedidia.webfactional.com/micro/screenshots.html). + +You can also check out the website for Micro at https://micro-editor.github.io. + +# Table of Contents +- [Features](#features) +- [Installation](#installation) + - [Prebuilt binaries](#prebuilt-binaries) + - [Package Managers](#package-managers) + - [Building from source](#building-from-source) + - [MacOS terminal](#macos-terminal) + - [Linux clipboard support](#linux-clipboard-support) + - [Colors and syntax highlighting](#colors-and-syntax-highlighting) + - [Plan9, Cygwin](#plan9-cygwin) +- [Usage](#usage) +- [Documentation and Help](#documentation-and-help) +- [Contributing](#contributing) + +- - - # Features -* Easy to use +* Easy to use and to install +* No dependencies or external files are needed -- just the binary you can download further down the page +* Multiple cursors * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...) + * Keybindings can be rebound to your liking +* Sane defaults + * You shouldn't have to configure much out of the box (and it is extremely easy to configure) +* Splits and tabs +* Nano-like menu to help you remember the keybindings * Extremely good mouse support -* Cross platform -* Syntax highlighting (in over [75 languages](runtime/syntax)!) + * This means mouse dragging to create a selection, double click to select by word, and triple click to select by line +* Cross platform (It should work on all the platforms Go runs on) + * Note that while Windows is supported, there are still some bugs that need to be worked out +* Plugin system (plugins are written in Lua) + * Micro has a built-in plugin manager to automatically install, remove, and update all your plugins +* Persistent undo +* Automatic linting and error notifications +* Syntax highlighting (for over [90 languages](runtime/syntax)!) * Colorscheme support + * By default, micro comes with 16, 256, and true color themes. * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it) -* Search and replace -* Undo and redo -* Unicode support +* Snippets + * The snippet plugin can be installed with `> plugin install snippets` * Copy and paste with the system clipboard * Small and simple -* Configurable +* Easily configurable +* Macros +* Common editor things such as undo/redo, line numbers, Unicode support, softwrap... -If you'd like to see what has been implemented, and what I plan on implementing soon-ish, see the [todo list](todolist.md) +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. # Installation -### Homebrew +To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source. + +If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro). + +### Prebuilt binaries + +All you need to install micro is one file, the binary itself. It's as simple as that! + +Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page. + +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. + +If you'd like to see more information after installing micro, run `micro -version`. + +### Installation script -If you are on Mac, you can install micro using Homebrew: +There is a great script which can install micro for you by downloading the latest prebuilt binary. You can find it at https://getmic.ro (the github repo for it is [here](https://github.com/benweissmann/getmic.ro)). + +Then you can easily install micro: + + $ curl https://getmic.ro | bash + +The script will install the micro binary to the current directory. + +See the [Github page](https://github.com/benweissmann/getmic.ro) for more information. + +### Package managers + +You can install micro using Homebrew on Mac: ``` -brew tap zyedidia/micro -brew install --devel micro +brew install micro ``` -Micro is devel-only for now because there is no released version. +On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop): -### Prebuilt binaries +``` +choco install micro +``` -| 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) | +or -To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use). +``` +scoop install micro +``` -### Building from source +On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install) -Micro is made in Go so you must have Go installed on your system to build it. +``` +snap install micro --classic +``` -You can simply `go get` it. +On OpenBSD, micro is available in the ports tree. It is also available as a binary package. ``` -go get -u github.com/zyedidia/micro/cmd/micro +pkg_add -v micro ``` -### Clipboard support +### Building from source + +If your operating system does not have a binary release, but does run Go, you can build from source. -On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu: +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 recommend setting it to `~/go` if you don't have one). ``` -$ sudo apt-get install xclip +go get -d github.com/zyedidia/micro/cmd/micro +cd $GOPATH/src/github.com/zyedidia/micro +make install ``` -# Usage +The binary will then be installed to `$GOPATH/bin` (or your `$GOBIN`). -Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer. +Please make sure that when you are working with micro's code, you are working on your `GOPATH`. -Micro also supports creating buffers from `stdin`: +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. -``` -$ ifconfig | micro +### MacOS terminal + +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. + +### Linux clipboard support + +On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed. + +For Ubuntu: + +```sh +sudo apt-get install xclip ``` -You can move the cursor around with the arrow keys and mouse. +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. + +### 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` +by pressing CtrlE in micro and typing `set colorscheme simple`. -#### Keybindings +If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set +to `xterm-256color`. -* 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 +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 +mintty. -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. +### Plan9, Cygwin + +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 +Plan9, and Cygwin (although this may change in the future). Micro also doesn't support NaCl (but NaCl is deprecated anyways). + +# Usage -# Configuration +Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer. -At this point, there isn't much you can configure. -Micro has a few options which you can set: +Micro also supports creating buffers from `stdin`: -* colorscheme -* tabsize -* syntax +```sh +ifconfig | micro +``` -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`. +You can move the cursor around with the arrow keys and mouse. -The syntax option can simply be on or off, so for example to turn syntax highlighting off, run `set syntax off`. +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. -The colorscheme can be selected from all the files in the `~/.micro/colorschemes/` directory. Micro comes by default with three colorschemes: +# Documentation and Help -* 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. +Micro has a built-in help system which you can access by pressing `Ctrl-E` and typing `help`. Additionally, you can +view the help files here: -These are embedded in the Go binary, but to see their source code, look [here](./runtime/colorschemes) +* [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) -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 -for you. If you'd like to take your configuration with you to another machine, simply copy the `settings.json` to the other machine. +I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for +a brief introduction to the more powerful configuration features micro offers. # Contributing If you find any bugs, please report them! I am also happy to accept pull requests from anyone. + +You can use the [GitHub issue tracker](https://github.com/zyedidia/micro/issues) +to report bugs, ask questions, or suggest new features. + +For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).