From 32434932a64e014b1925433ced8bfcadb59f8a77 Mon Sep 17 00:00:00 2001 From: ClementTsang <34804052+ClementTsang@users.noreply.github.com> Date: Thu, 26 Jan 2023 21:37:09 -0500 Subject: [PATCH] docs: update some packaging/distribution docs with more details --- .../packaging-and-distribution.md | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/content/contribution/packaging-and-distribution.md b/docs/content/contribution/packaging-and-distribution.md index 16897903..104217c2 100644 --- a/docs/content/contribution/packaging-and-distribution.md +++ b/docs/content/contribution/packaging-and-distribution.md @@ -1,18 +1,26 @@ # Packaging and Distribution -Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom. +Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution +and bottom. ## Pre-built binaries -The latest stable release can be found [here](https://github.com/ClementTsang/bottom/releases/latest), where you can find pre-built binaries in either a `tar.gz` or `zip` format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging +The latest stable release can be found [here](https://github.com/ClementTsang/bottom/releases/latest), where you ca +find pre-built binaries in either a `tar.gz` or `zip` format. Binaries here also include automatically generated shell +completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging process. -You can also find a nightly build in the [releases page](https://github.com/ClementTsang/bottom/releases), built every day at 00:00 UTC off of the master branch. +You can also find a nightly build in the [releases page](https://github.com/ClementTsang/bottom/releases), built every +day at 00:00 UTC off of the master branch. + +In both cases, we use a combination of GitHub Actions and CirrusCI (mainly for FreeBSD and macOS M1) to create our +release binaries. [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml) +contains the GitHub Action workflow used to do both of these, if reference is needed. ## Building manually -If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version of stable Rust, which you can get with: +If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version +of stable Rust, which you can get with: ```bash rustup update stable @@ -51,8 +59,9 @@ file or the [binary build CI workflow](https://github.com/ClementTsang/bottom/bl ## Adding an installation source -Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) file under the [Installation](https://github.com/ClementTsang/bottom#installation) section. -Once that's done, open a pull request - these will usually be approved of very quickly. +Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add +the installation method and any details to the [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) +file under the [Installation](https://github.com/ClementTsang/bottom#installation) section, as well as a corresponding +table of contents entry. Once that's done, open a pull request - these will usually be approved of very quickly. You can find more info on the contribution process [here](../issues-and-pull-requests/#pull-requests).