From 87ad6fc0bbd1bc1c62aaff910965b06e3334fb2b Mon Sep 17 00:00:00 2001 From: Dmitry Maluka Date: Wed, 18 Aug 2021 21:35:49 +0200 Subject: [PATCH 1/4] plugins.md: update link to the internal documentation (#2191) godoc.org now redirects to pkg.go.dev and it's not obvious how to locate the internal packages documentation at https://pkg.go.dev/github.com/zyedidia/micro --- runtime/help/plugins.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/runtime/help/plugins.md b/runtime/help/plugins.md index f671f776..723248eb 100644 --- a/runtime/help/plugins.md +++ b/runtime/help/plugins.md @@ -293,10 +293,10 @@ returned by the functions have many methods. The Lua plugin may access any public methods of an object returned by any of the functions above. Unfortunately it is not possible to list all the available functions on this page. Please go to the internal documentation at -https://godoc.org/github.com/zyedidia/micro to see the full list of available -methods. Note that only methods of types that are available to plugins via -the functions above can be called from a plugin. For an even more detailed -reference see the source code on Github. +https://pkg.go.dev/github.com/zyedidia/micro/v2/internal to see the full list +of available methods. Note that only methods of types that are available to +plugins via the functions above can be called from a plugin. For an even more +detailed reference see the source code on Github. For example, with a BufPane object called `bp`, you could call the `Save` function in Lua with `bp:Save()`. From 272f3adcc499bc24fbc112da580b0a4a23ba1677 Mon Sep 17 00:00:00 2001 From: Zachary Yedidia Date: Wed, 18 Aug 2021 16:13:17 -0400 Subject: [PATCH 2/4] Add eget to install instructions --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e6b48d5c..ebb8caa2 100644 --- a/README.md +++ b/README.md @@ -81,17 +81,13 @@ stable version if you install from the prebuilt binaries, Homebrew, or Snap. A desktop entry file and man page can be found in the [assets/packaging](https://github.com/zyedidia/micro/tree/master/assets/packaging) directory. -### Prebuilt binaries +### Pre-built binaries -All you need to install micro is one file, the binary itself. It's as simple as that! +Pre-built binaries are distributed with [releases](https://github.com/zyedidia/micro/releases). -Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page. +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 . - -You can easily install micro by running +#### Quick-install script ```bash curl https://getmic.ro | bash @@ -99,7 +95,22 @@ curl https://getmic.ro | bash 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. -To uninstall micro, simply remove the binary, and the configuration directory at `~/.config/micro`. +#### 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 8pm ET) +eget --tag v2.0.8 zyedidia/micro # download version 2.0.8 rather than the latest release +``` + +See [Eget](https://github.com/zyedidia/eget) for more information. ### Package managers From fb1e7eababaf86546299d329281b55d356428d29 Mon Sep 17 00:00:00 2001 From: Zachary Yedidia Date: Wed, 18 Aug 2021 16:55:22 -0400 Subject: [PATCH 3/4] Update install instructions --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ebb8caa2..5e8f7348 100644 --- a/README.md +++ b/README.md @@ -106,10 +106,12 @@ 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 8pm ET) +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 @@ -134,11 +136,11 @@ 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. * Linux: Available in distro-specific package managers. - * `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. + * `dnf install micro` (Fedora). * `pacman -S micro` (Arch Linux). * `eopkg install micro` (Solus). From 0c2e1396729c6de7384709b1f52cf516f5ddc4c9 Mon Sep 17 00:00:00 2001 From: Zachary Yedidia Date: Wed, 18 Aug 2021 16:55:51 -0400 Subject: [PATCH 4/4] Fix formatting --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e8f7348..6ed5b982 100644 --- a/README.md +++ b/README.md @@ -139,8 +139,9 @@ 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. -* Linux: Available in distro-specific package managers. + +* Linux: Available in distro-specific package managers. * `dnf install micro` (Fedora). * `pacman -S micro` (Arch Linux). * `eopkg install micro` (Solus).