X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=320a6cb3739ef6deaf9b8ecf6cbdcfca3caebf6d;hb=90304fb472fab5a9809feb0d9b23b0930619cf0d;hp=179484a7b902512531c9ebc57ff0e4ac5ab02afd;hpb=741f494841bedfa6d6ef20a017ee91332974002e;p=micro.git diff --git a/README.md b/README.md index 179484a7..320a6cb3 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,36 @@ -# ![Micro](./assets/logo.png) +
+ +
[![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro) +[![Release](https://img.shields.io/github/release/zyedidia/micro.svg?label=Release)](https://github.com/zyedidia/micro/releases) [![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. +**micro** is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the capabilities +of modern terminals. It comes as a single, batteries-included, static binary with no dependencies; 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). +As its name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use. +It strives to be enjoyable as a full-time editor for people who prefer to work in a terminal, or those who regularly edit files over SSH. 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). +To see more screenshots of micro, showcasing some of the default color schemes, 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 +## 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) + - [macOS terminal](#macos-terminal) - [Linux clipboard support](#linux-clipboard-support) - [Colors and syntax highlighting](#colors-and-syntax-highlighting) - [Plan9, Cygwin, Mingw](#plan9-cygwin-mingw) @@ -36,35 +40,38 @@ You can also check out the website for Micro at https://micro-editor.github.io. - - - -# Features - -* Easy to use and to install -* No dependencies or external files are needed -- just the binary you can download further down the page -* Multiple cursors -* 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 -* 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) - * Note that while Windows is supported Mingw/Cygwin is not (see below) -* Plugin system (plugins are written in Lua) -* Persistent undo -* Automatic linting and error notifications -* Syntax highlighting (for over [120 languages](runtime/syntax)!) -* Colorscheme support - * By default, micro comes with 16, 256, and true color themes. -* True color support (set the `MICRO_TRUECOLOR` environment variable to 1 to enable it) -* Copy and paste with the system clipboard -* Small and simple -* Easily configurable -* Macros -* Common editor things such as undo/redo, line numbers, Unicode support, softwrap... - -# Installation +## Features + +- Easy to use and install. +- No dependencies or external files are needed â just the binary you can download further down the page. +- Multiple cursors. +- 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. +- 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). + - Note that while Windows is supported Mingw/Cygwin is not (see below) +- Plugin system (plugins are written in Lua). + - micro has a built-in plugin manager to automatically install, remove, and update plugins. +- Built-in diff gutter +- Simple autocompletion +- Persistent undo. +- Automatic linting and error notifications +- Syntax highlighting for over [130 languages](runtime/syntax). +- Color scheme support. + - By default, micro comes with 16, 256, and true color themes. +- True color support (set the `MICRO_TRUECOLOR` environment variable to 1 to enable it). +- Copy and paste with the system clipboard. +- Small and simple. +- Easily configurable. +- Macros. +- Common editor features such as undo/redo, line numbers, Unicode support, soft wrapping, ⦠+ +## Installation To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source. @@ -79,19 +86,19 @@ Download the binary from the [releases](https://github.com/zyedidia/micro/releas 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. -If you'd like to see more information after installing micro, run `micro -version`. +Running `micro -version` will give you the version information. ### 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)). +There is a script which can install micro for you by downloading the latest prebuilt binary. You can find it at