X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=698c32d660bf2ebacbc2386056bb31a4e47a68f0;hb=c01ba97215679c3a365e22f7aae4fb844426aa8e;hp=a1b7e8d84be2fb09f70e3e2313cf8acb2f4552de;hpb=fa56a477c2dc73592cb1c01a9c29d9a22c8234f1;p=micro.git diff --git a/README.md b/README.md index a1b7e8d8..698c32d6 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. @@ -49,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 @@ -68,7 +69,19 @@ 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 +### Installation script + +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: @@ -76,23 +89,35 @@ You can install micro using Homebrew on Mac: brew install micro ``` -On Windows, you can install micro through Chocolatey: +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 --edge --classic +snap install micro --classic +``` + +On OpenBSD, micro is available in the ports tree. It is also available as a binary package. + +``` +pkg_add -v micro ``` ### Building from source 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). +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). ``` go get -d github.com/zyedidia/micro/cmd/micro @@ -108,7 +133,7 @@ You can install directly with `go get` (`go get -u github.com/zyedidia/micro/cmd ### 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. The newest versions also support true color. +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 @@ -136,11 +161,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