X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=1dfb70a15dd941f85e38ee191dc368248a140e9e;hb=e7e02729685de27429e220f38250065e2f80ec87;hp=9e9e955c2d25d6d3bc2f983cc2c8e73c6cec3d72;hpb=e40ff56e07a14e0a25d3b797cf133cb5ec251bab;p=micro.git diff --git a/README.md b/README.md index 9e9e955c..1dfb70a1 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,25 @@ Here is a picture of micro editing its source code. ![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 and to install @@ -30,6 +46,7 @@ You can also check out the website for Micro at https://micro-editor.github.io. * 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 * 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) @@ -50,7 +67,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 @@ -69,7 +86,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: @@ -92,14 +121,20 @@ 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 @@ -115,7 +150,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