X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=862dd2fe84eed9144c239e00c98d8ffd6f8ac38f;hb=ade0e9dd39e6859a191d5b1a7061622fe5b57a01;hp=579d78fc63ca1e840d6acd38a2ca6a35d676051c;hpb=379a49f9449bf1524bb050a4694824a39be13a42;p=micro.git diff --git a/README.md b/README.md index 579d78fc..862dd2fe 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![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) +[![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. @@ -23,6 +24,7 @@ You can also check out the website for Micro at https://micro-editor.github.io. * 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 @@ -48,7 +50,7 @@ You can also check out the website for Micro at https://micro-editor.github.io. * 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)), and multiple cursors ([#5](https://github.com/zyedidia/micro/issues/5)) in the future. +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 @@ -67,14 +69,32 @@ 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`. -### Homebrew +### Package Managers -You can also install micro using Homebrew on Mac: +You can install micro using Homebrew on Mac: ``` 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 +``` + +On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install) + +``` +snap install micro --classic +``` + ### Building from source If your operating system does not have a binary release, but does run Go, you can build from source. @@ -82,15 +102,21 @@ If your operating system does not have a binary release, but does run Go, you ca 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). ``` -go get -d 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 + +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. @@ -117,11 +143,11 @@ 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, NaCl, Cygwin +### 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, NaCl, and Cygwin (although this may change in the future). +Plan9, and Cygwin (although this may change in the future). Micro also doesn't support NaCl (but NaCl is deprecated anyways). # Usage @@ -158,6 +184,7 @@ a brief introduction to the more powerful configuration features micro offers. 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. +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).