Update README.md

[micro.git] / README.md

diff --git a/README.md b/README.md
index c3a1a617e08425be0b4ee5912f9c77d76578bc14..ee2ef2e0656e69ae4d4ce4f77d017c162217fa64 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Micro
 
 [![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)
 [![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)
 
@@ -16,71 +16,57 @@ Here is a picture of micro editing its source code.
 
 # 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
 * Common keybindings (ctrl-s, ctrl-c, ctrl-v, ctrl-z...)
+    * Keybindings can be rebound to your liking
 * Extremely good mouse support
-* Cross platform
-* Syntax highlighting (in over [75 languages](runtime/syntax)!)
+* Cross platform (It should work on all the platforms Go runs on)
+* Plugin system (plugins are written in Lua)
+* Syntax highlighting (for over [75 languages](runtime/syntax)!)
 * Colorscheme support
 * True color support (set the `MICRO_TRUECOLOR` env variable to 1 to enable it)
-* Search and replace
 * Sane defaults
-* Plugin system (plugins are written in Lua)
-* Undo and redo
-* Unicode support
 * Copy and paste with the system clipboard
 * Small and simple
 * Easily configurable
+* Common editor things such as undo/redo, line numbers, unicode support...
 
 # Installation
 
-### Homebrew
+This section gives instructions for how to simply install micro using the prebuilt binaries, or building from source.
 
-If you are on Mac, you can install micro using Homebrew:
+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.
 
-```
-brew tap zyedidia/micro
-brew install --devel micro
-```
+### Prebuilt binaries
 
-Micro is devel-only for now because there is no released version.
+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!
 
-### Prebuilt binaries
+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`.
 
-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)
-
-To run the micro binary just run `./bin/micro` (you may want to place the binary on your path for ease of use).
+[You can find the binaries in the nightly build release](https://github.com/zyedidia/micro/releases/tag/nightly)
 
-### Building from source
+To run the micro binary just run `./micro` (you probably want to place the binary on your `$PATH` for ease of use).
 
-Micro is made in Go so you must have Go installed on your system to build it.
+### Building from source
 
 Make sure that you have Go version 1.4 or greater.
 
-You can simply `go get` it.
-
-```
-go get -u github.com/zyedidia/micro/cmd/micro
+```sh
+go get -u github.com/zyedidia/micro/...
 ```
 
 ### Clipboard support
 
-On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed. For Ubuntu:
+On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.
 
-```
-$ sudo apt-get install xclip
+For Ubuntu:
+
+```sh
+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.
@@ -91,8 +77,8 @@ Once you have built the editor, simply start it by running `micro path/to/file.t
 
 Micro also supports creating buffers from `stdin`:
 
-```
-$ ifconfig | micro
+```sh
+ifconfig | micro
 ```
 
 You can move the cursor around with the arrow keys and mouse.
@@ -104,7 +90,7 @@ You can run `$ micro -version` to get the version number. Since there is no rele
 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.
 
-#### Help text
+### Help text
 
 See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
 configuration options.