]> git.lizzy.rs Git - micro.git/blobdiff - README.md
projects / micro.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add gruvbox colorscheme
[micro.git] / README.md
diff --git a/README.md b/README.md
index 057b901480f8c63fc5af17938e0d4bfc7f546495..66174e4e35b9c3129d21036c83d5d1a2d6c4f8b9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
 # Micro
 
 [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
 # 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)
 
 [![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
+> Micro is still a work in progress
 
 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.
 
 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.
@@ -16,56 +16,51 @@ Here is a picture of micro editing its source code.
 
 # Features
 
 
 # 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...)
 * 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)
 * Extremely good mouse support
 * Extremely good mouse support
-* Cross platform
-* Syntax highlighting (in over [75 languages](runtime/syntax)!)
+    * 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)
+* Plugin system (plugins are written in Lua)
+* Automatic linting and error notifications
+* Syntax highlighting (for over [75 languages](runtime/syntax)!)
 * Colorscheme support
 * 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)
 * 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
 * Copy and paste with the system clipboard
 * Small and simple
 * Easily configurable
+* Common editor things such as undo/redo, line numbers, unicode support...
 
 # Installation
 
 
 # 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, or you can build it from source.
 
 You can also install micro with a few package managers (on OSX, Arch Linux, and CRUX). 
 
 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.
+See this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro) for details.
+
+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).
 
 ### Prebuilt binaries
 
 
 ### 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!
+
+You can download the correct binary for your operating system from the list in the [nightly build release](https://github.com/zyedidia/micro/releases/tag/nightly).
 
 Micro has no released version, instead these binaries are compiled every night and you can find the
 
 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 probably want to place the binary on your `$PATH` for ease of use).
+commit they were compiled with by running `micro -version`.
+
+If your operating system does not have binary, but does run Go, you can build from source.
 
 ### Building from source
 
 
 ### Building from source
 
-Make sure that you have Go version 1.4 or greater.
+Make sure that you have Go version 1.5 or greater (Go 1.4 will work for the systems like support CGO then).
 
 ```sh
 go get -u github.com/zyedidia/micro/...
 
 ```sh
 go get -u github.com/zyedidia/micro/...
@@ -95,17 +90,14 @@ ifconfig | micro
 
 You can move the cursor around with the arrow keys and mouse.
 
 
 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 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.
+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.
 
 
-### Help text
+### Documentation and Help
 
 
-See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
-configuration options.
+Micro has a built-in help system which you can access by pressing `CtrlE` and typing `help`. Additionally, you can
+view the help files online [here](https://github.com/zyedidia/micro/tree/master/runtime/help).
 
 # Contributing
 
 
 # Contributing
 
A modern and intuitive terminal-based text editor