X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=6ed5b982b69d0dcf43243986a12f30d661a1c4c9;hb=c2d7b62e8fdc535330aea79e463a449ed3b4ef51;hp=9b4cff4f36fb73bcd904b312f0f63b5e4f49e371;hpb=399c6290768867351813250a6f1d8df7554917a5;p=micro.git
diff --git a/README.md b/README.md
index 9b4cff4f..6ed5b982 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
[![Release](https://img.shields.io/github/release/zyedidia/micro.svg?label=Release)](https://github.com/zyedidia/micro/releases)
[![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)
-[![Snap Status](https://build.snapcraft.io/badge/zyedidia/micro.svg)](https://build.snapcraft.io/user/zyedidia/micro)
+[![Snap Status](https://snapcraft.io/micro/badge.svg)](https://snapcraft.io/micro)
**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!
@@ -17,7 +17,7 @@ Here is a picture of micro editing its source code.
![Screenshot](./assets/micro-solarized.png)
-To see more screenshots of micro, showcasing some of the default color schemes, see [here](http://zbyedidia.webfactional.com/micro/screenshots.html).
+To see more screenshots of micro, showcasing some of the default color schemes, see [here](https://micro-editor.github.io).
You can also check out the website for Micro at https://micro-editor.github.io.
@@ -28,10 +28,11 @@ You can also check out the website for Micro at https://micro-editor.github.io.
- [Prebuilt binaries](#prebuilt-binaries)
- [Package Managers](#package-managers)
- [Building from source](#building-from-source)
+ - [Fully static binary](#fully-static-binary)
- [macOS terminal](#macos-terminal)
- [Linux clipboard support](#linux-clipboard-support)
- [Colors and syntax highlighting](#colors-and-syntax-highlighting)
- - [Plan9, Cygwin, Mingw](#plan9-cygwin-mingw)
+ - [Cygwin, Mingw, Plan9](#cygwin-mingw-plan9)
- [Usage](#usage)
- [Documentation and Help](#documentation-and-help)
- [Contributing](#contributing)
@@ -43,7 +44,7 @@ You can also check out the website for Micro at https://micro-editor.github.io.
- 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, â¦).
+- 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).
@@ -52,13 +53,13 @@ You can also check out the website for Micro at https://micro-editor.github.io.
- 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)
+ - 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
+- Built-in diff gutter.
+- Simple autocompletion.
- Persistent undo.
-- Automatic linting and error notifications
+- 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.
@@ -75,28 +76,43 @@ To install micro, you can download a [prebuilt binary](https://github.com/zyedid
If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).
-### Prebuilt binaries
+Use `micro -version` to get the version information after installing. It is only guaranteed that you are installing the most recent
+stable version if you install from the prebuilt binaries, Homebrew, or Snap.
-All you need to install micro is one file, the binary itself. It's as simple as that!
+A desktop entry file and man page can be found in the [assets/packaging](https://github.com/zyedidia/micro/tree/master/assets/packaging) directory.
-Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
+### Pre-built binaries
-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.
+Pre-built binaries are distributed with [releases](https://github.com/zyedidia/micro/releases).
-Running `micro -version` will give you the version information.
+To uninstall micro, simply remove the binary, and the configuration directory at `~/.config/micro`.
-### Installation script
-
-There is a script which can install micro for you by downloading the latest prebuilt binary. You can find it at .
-
-Then you can easily install micro:
+#### Quick-install script
```bash
curl https://getmic.ro | bash
```
-The script will install the micro binary to the current directory. See its [GitHub repository](https://github.com/benweissmann/getmic.ro) for more information.
+The script will place the micro binary in the current directory. From there, you can move it to a directory on your path of your choosing (e.g. `sudo mv micro /usr/bin`). See its [GitHub repository](https://github.com/benweissmann/getmic.ro) for more information.
+
+#### Eget
+
+With [Eget](https://github.com/zyedidia/eget) installed, you can easily get a pre-built binary:
+
+```
+eget zyedidia/micro
+```
+
+Use `--tag VERSION` to download a specific tagged version.
+
+```
+eget --tag nightly zyedidia/micro # download the nightly version (compiled every day at midnight UTC)
+eget --tag v2.0.8 zyedidia/micro # download version 2.0.8 rather than the latest release
+```
+
+You can install `micro` by adding `--to /usr/local/bin` to the `eget` command, or move the binary manually to a directory on your `$PATH` after the download completes.
+
+See [Eget](https://github.com/zyedidia/eget) for more information.
### Package managers
@@ -106,22 +122,37 @@ You can install micro using Homebrew on Mac:
brew install micro
```
-On Debian Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)
+**Note for Mac:** All micro keybindings use the control or alt (option) key, not the command
+key. By default, macOS terminals do not forward alt key events. To fix this, please see
+the section on [macOS terminals](https://github.com/zyedidia/micro#macos-terminal) further below.
+
+On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)
```
snap install micro --classic
```
-Homebrew and snap are the two "officially" maintained package manager distributions of micro.
+**Note for Linux:** for interfacing with the local system clipboard, `xclip` or `xsel`
+must be installed. Please see the section on [Linux clipboard support](https://github.com/zyedidia/micro#linux-clipboard-support)
+further below.
+
+Micro is also available through other package managers on Linux such dnf, AUR, Nix, and package managers
+for other operating systems. These packages are not guaranteed to be up-to-date.
-Micro is also available through other package managers on Linux such as AUR, Nix, and package managers
-for other operating systems:
+
-* Windows: [Chocolatey](https://chocolatey.org) and [Scoop](https://github.com/lukesampson/scoop)
- * `choco install micro`
- * `scoop install micro`
-* OpenBSD: Available in the ports tree and also available as a binary package
- * `pkd_add -v micro`
+* Linux: Available in distro-specific package managers.
+ * `dnf install micro` (Fedora).
+ * `pacman -S micro` (Arch Linux).
+ * `eopkg install micro` (Solus).
+ * See [wiki](https://github.com/zyedidia/micro/wiki/Installing-Micro) for details about CRUX, Termux.
+* Windows: [Chocolatey](https://chocolatey.org) and [Scoop](https://github.com/lukesampson/scoop).
+ * `choco install micro`.
+ * `scoop install micro`.
+* OpenBSD: Available in the ports tree and also available as a binary package.
+ * `pkd_add -v micro`.
+* NetBSD, macOS, Linux, Illumos, etc. with [pkgsrc](http://www.pkgsrc.org/)-current:
+ * `pkg_add micro`
### Building from source
@@ -157,28 +188,25 @@ CGO_ENABLED=0 make build
### macOS terminal
-If you are using macOS, you should consider using [iTerm2](http://iterm2.com/) instead of the default terminal (Terminal.app). 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.
+If you are using macOS, you should consider using [iTerm2](http://iterm2.com/) instead of the default terminal (Terminal.app). 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->Presets...`, and select `Esc+` for `Left Option Key` in the same menu. The newest versions also support true color.
If you still insist on using the default Mac terminal, be sure to set `Use Option key as Meta key` under
`Preferences->Profiles->Keyboard` to use option as alt.
### Linux clipboard support
-On Linux, clipboard support requires the `xclip` or `xsel` commands to be installed.
+On Linux, clipboard support requires:
-For Ubuntu:
+- On X11, the `xclip` or `xsel` commands (for Ubuntu: `sudo apt install xclip`)
+- On Wayland, the `wl-clipboard` command
-```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.
+If you don't have these commands, 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 mode. Try changing the color scheme to `simple`
-by pressing Ctrl+E in micro and typing `set colorscheme simple`.
+by pressing Ctrl-e in micro and typing `set colorscheme simple`.
If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
to `xterm-256color`.
@@ -219,7 +247,7 @@ click to enable line selection.
## Documentation and Help
-micro has a built-in help system which you can access by pressing Ctrl+E and typing `help`. Additionally, you can
+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:
- [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
@@ -240,3 +268,5 @@ 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).
+
+Sometimes I am unresponsive, and I apologize! If that happens, please ping me.