don't clone unsaved file buffers.

[micro.git] / README.md

diff --git a/README.md b/README.md
index 493936e76490a3691cd33f432af9ef9877998e71..74745ac4f4192ff4a5bdcda909cf110dd6170366 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,104 +1,88 @@
-# Micro
+# ![Micro](./assets/logo.png)

 
 [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/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)](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)
 
 [![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 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.
 

+As the name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use in a pinch, but micro also aims to be
+enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).
+

 Here is a picture of micro editing its source code.
 
 Here is a picture of micro editing its source code.
 

-![Screenshot](./screenshot.png)
+![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).

 
 # 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)
+* Splits and tabs

 * 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)
+    * Note that while Windows is supported, there are still some bugs that need to be worked out
+* Plugin system (plugins are written in Lua)
+* Persistent undo
+* 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

+* Macros
+* Common editor things such as undo/redo, line numbers, Unicode support...
+
+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.

 
 # Installation
 
 
 # Installation
 

-Micro is devel-only for now because there is no released version.
+To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.

 
 

-### OSX
+If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).

 
 

-If you are on OSX, you can install micro using Homebrew:
+### Prebuilt binaries

 
 

-```sh
-brew tap zyedidia/micro
-brew install --devel micro
-```
+All you need to install micro is one file, the binary itself. It's as simple as that!

 
 

-### Arch Linux
+Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.

 
 

-If you are on Arch Linux, you can install micro using the AUR:
+On that page you'll see the nightly release, which contains binaries for micro which are built every night,
+and you'll see all the stable releases with the corresponding binaries.

 
 

-```sh
-wget https://aur.archlinux.org/cgit/aur.git/snapshot/micro-git.tar.gz
-cd micro-git
-makepkg -si
-```
+If you'd like to see more information after installing micro, run `micro -version`.

 
 

-### CRUX
+### Homebrew

 
 

-If you are on CRUX, you can install micro using the 6c37-git repo:
+You can also install micro using Homebrew on Mac:

 
 

-```sh
-git clone https://github.com/6c37/crux-ports-git
-cd crux-ports-git/micro
-# make sure you have go installed!
-pkgmk -i

 ```
 ```

-
-### Prebuilt binaries
-
-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).
+$ brew install micro
+```

 
 ### Building from source
 
 
 ### Building from source
 

-Micro is made in Go so you must have Go installed on your system to build it.
+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.4 or greater.
-
-You can simply `go get` it.
+Make sure that you have Go version 1.5 or greater (Go 1.4 will work if your version supports CGO).

 
 ```sh
 
 ```sh

-go get -u github.com/zyedidia/micro/cmd/micro
+go get -u github.com/zyedidia/micro/...

 ```
 
 ```
 

-### Clipboard support
+### Linux clipboard support

 
 

-On Linux, clipboard support requires 'xclip' or 'xsel' command to be installed.
+On Linux, clipboard support requires the 'xclip' or 'xsel' commands to be installed.

 
 For Ubuntu:
 
 
 For Ubuntu:
 


@@ -108,6 +92,26 @@ 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.
 
 
 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.
 

+### Colors and syntax highlighting
+
+If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
+you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
+by running `> set colorscheme simple`.
+
+If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
+to `xterm-256color`.
+
+Many of the Windows terminals don't support more than 16 colors, which means
+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
+
+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).
+

 # Usage
 
 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
 # Usage
 
 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.


@@ -120,18 +124,29 @@ 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 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.
+# Documentation and Help

 
 

-### Help text
+Micro has a built-in help system which you can access by pressing `Ctrl-E` and typing `help`. Additionally, you can
+view the help files here:

 
 

-See the [help text](./runtime/help/help.md) for information about keybindings, editor commands, colorschemes and
-configuration options.
+* [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
+* [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
+* [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
+* [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
+* [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
+* [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
+
+I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
+a brief introduction to the more powerful configuration features micro offers.

 
 # Contributing
 
 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
 
 # Contributing
 
 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.
+
+For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).