X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=862dd2fe84eed9144c239e00c98d8ffd6f8ac38f;hb=ade0e9dd39e6859a191d5b1a7061622fe5b57a01;hp=e5b7a2b1a7e39bf8c91767eca428ca0917ed5d85;hpb=3f0c5791b4c91cf0b7d92f5b80c2d89a3535de59;p=micro.git diff --git a/README.md b/README.md index e5b7a2b1..862dd2fe 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,125 @@ -# 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. 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. # Features * 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 * Extremely good mouse support + * 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) -* Syntax highlighting (for over [75 languages](runtime/syntax)!) + * 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) -* Sane defaults +* Snippets + * The snippet plugin can be installed with `> plugin install snippets` * Copy and paste with the system clipboard * Small and simple * Easily configurable -* Common editor things such as undo/redo, line numbers, unicode support... +* Macros +* Common editor things such as undo/redo, line numbers, Unicode support, softwrap... + +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 -This section gives instructions for how to simply install micro using the prebuilt binaries, or building from source. +To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source. -You can also install micro with a few package managers (on OSX, Arch Linux, and CRUX). -See the [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro) for details. +If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro). ### Prebuilt binaries -To easily install micro on any of the operating systems listed below, just download the tar file, -extract it, and run the binary inside. It's as simple as that! +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`. + +### Package Managers -Micro has no released version, instead these binaries are compiled every night and you can find the -commit it was compiled with by running `micro -version`. +You can install micro using Homebrew on Mac: -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) -* [FreeBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd64.tar.gz) -* [FreeBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-freebsd32.tar.gz) -* [OpenBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd64.tar.gz) -* [OpenBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-openbsd32.tar.gz) -* [NetBSD 64](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd64.tar.gz) -* [NetBSD 32](http://zbyedidia.webfactional.com/micro/binaries/micro-netbsd32.tar.gz) -* [Windows 64](http://zbyedidia.webfactional.com/micro/binaries/micro-win64.zip) -* [Windows 32](http://zbyedidia.webfactional.com/micro/binaries/micro-win32.zip) +``` +brew install micro +``` + +On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop): + +``` +choco install micro +``` + +or + +``` +scoop install micro +``` -To run the micro binary just run `./micro` (you probably want to place the binary on your `$PATH` for ease of use). +On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install) + +``` +snap install micro --classic +``` ### Building from source -Make sure that you have Go version 1.4 or greater. +If your operating system does not have a binary release, but does run Go, you can build from source. + +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). -```sh -go get -u github.com/zyedidia/micro/... ``` +go get -d github.com/zyedidia/micro/cmd/micro +cd $GOPATH/src/github.com/zyedidia/micro +make install +``` + +The binary will then be installed to `$GOPATH/bin` (or your `$GOBIN`). + +Please make sure that when you are working with micro's code, you are working on your `GOPATH`. + +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. + +### MacOS terminal -### Clipboard support +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. -On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. +### Linux clipboard support + +On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed. For Ubuntu: @@ -83,6 +129,26 @@ 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. +### 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`. + +If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set +to `xterm-256color`. + +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. + +### 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 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer. @@ -95,18 +161,30 @@ ifconfig | micro You can move the cursor around with the arrow keys and mouse. -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 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. + +# Documentation and Help -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. +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: -### Help text +* [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) -See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and -configuration options. +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).