]> git.lizzy.rs Git - micro.git/blobdiff - README.md
Lua syntax highlighting: Various fixes (#2426)
[micro.git] / README.md
index 1cfe589ec2bc27323db36ef6ad59454d435dc306..60b35edb6600650256c4826511317ccac26e5875 100644 (file)
--- 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.
 
@@ -25,14 +25,14 @@ You can also check out the website for Micro at https://micro-editor.github.io.
 
 - [Features](#features)
 - [Installation](#installation)
-  - [Prebuilt binaries](#prebuilt-binaries)
+  - [Prebuilt binaries](#pre-built-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)
@@ -79,23 +79,40 @@ If you want more information about ways to install micro, see this [wiki page](h
 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.
 
-### Prebuilt binaries
+A desktop entry file and man page can be found in the [assets/packaging](https://github.com/zyedidia/micro/tree/master/assets/packaging) directory.
 
-All you need to install micro is one file, the binary itself. It's as simple as that!
+### Pre-built binaries
 
-Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
+Pre-built binaries are distributed with [releases](https://github.com/zyedidia/micro/releases).
 
-### Installation script
+To uninstall micro, simply remove the binary, and the configuration directory at `~/.config/micro`.
 
-There is a script which can install micro for you by downloading the latest prebuilt binary. You can find it at <https://getmic.ro>.
-
-You can easily install micro by running
+#### Quick-install script
 
 ```bash
 curl https://getmic.ro | bash
 ```
 
-The script will place the micro binary in 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
 
@@ -119,13 +136,15 @@ snap install micro --classic
 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 as apt, dnf, AUR, Nix, and package managers
+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.
 
+<!-- * `apt install micro` (Ubuntu 20.04 `focal`, and Debian `unstable | testing | buster-backports`). At the moment, this package (2.0.1-1) is outdated and has a known bug where debug mode is enabled. -->
+
 * Linux: Available in distro-specific package managers.
-    * `apt install micro` (Ubuntu 20.04 `focal`, and Debian `unstable | testing | buster-backports`).
     * `dnf install micro` (Fedora).
-    * `yay -S micro` (Arch Linux).
+    * `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`.
@@ -134,12 +153,14 @@ for other operating systems. These packages are not guaranteed to be up-to-date.
     * `pkd_add -v micro`.
 * NetBSD, macOS, Linux, Illumos, etc. with [pkgsrc](http://www.pkgsrc.org/)-current:
     * `pkg_add micro`
+* macOS with [MacPorts](https://www.macports.org):
+    * `sudo port install micro`
 
 ### Building from source
 
 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.11 or greater and Go modules are enabled.
+Make sure that you have Go version 1.16 or greater and Go modules are enabled.
 
 ```
 git clone https://github.com/zyedidia/micro
@@ -241,6 +262,8 @@ view the help files here:
 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.
 
+There is also an unofficial Discord, which you can join at https://discord.gg/nhWR6armnR.
+
 ## Contributing
 
 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
@@ -248,6 +271,6 @@ If you find any bugs, please report them! I am also happy to accept pull request
 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).
+For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro) or the [Discord](https://discord.gg/nhWR6armnR).
 
 Sometimes I am unresponsive, and I apologize! If that happens, please ping me.