From c35a6ba9381149edbfe2ca3a1e52a9d46279b5d0 Mon Sep 17 00:00:00 2001 From: Jae-Heon Ji <32578710+jaeheonji@users.noreply.github.com> Date: Mon, 15 Nov 2021 17:06:13 +0900 Subject: [PATCH] doc: add INSTALL.md (#857) * doc: add INSTALL.md * doc(install): add warning phrase * doc(install): fix syntax * doc(install): change the install doc to be for third party --- README.md | 5 +++-- THIRD_PARTY_INSTALL.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 THIRD_PARTY_INSTALL.md diff --git a/README.md b/README.md index 7c2b6934..eb367338 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,14 @@ For more details about our future plans, read about upcoming features in our [ro Zellij was initially called "Mosaic". ## How do I install it? -You can install it through `cargo`: + +You can install with `cargo`: ``` cargo install zellij ``` -Or you can download a prebuilt binary from our [Releases](https://github.com/zellij-org/zellij/releases). +Or you can download a prebuilt binary from our [Releases](https://github.com/zellij-org/zellij/releases), or use [Third Party Repositories](THIRD_PARTY_INSTALL.md). The default plugins make use of characters that are mostly found in [nerdfonts](https://www.nerdfonts.com/). To get the best experience either install nerdfonts, or use the simplified ui by starting Zellij with `zellij options --simplified-ui`, or putting `simplified_ui: true` in the config file. diff --git a/THIRD_PARTY_INSTALL.md b/THIRD_PARTY_INSTALL.md new file mode 100644 index 00000000..dd47cad8 --- /dev/null +++ b/THIRD_PARTY_INSTALL.md @@ -0,0 +1,37 @@ +# Third Party Install + +* [Packages](#package) + * [Arch Linux](#arch-linux) + * [MacOS](#macos) + +## Packages + + :warning: **These packages are not affiliated with the Zellij maintainers and are provided here for convenience.** + +[![Packaging status](https://repology.org/badge/vertical-allrepos/zellij.svg)](https://repology.org/project/zellij/versions) + +### Arch Linux +You can install the `zellij` package from the [official community repository](https://archlinux.org/packages/community/x86_64/zellij/): + +``` +pacman -S zellij +``` + +Or install from AUR repository with [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers): + +``` +paru -S zellij-git +``` + +### MacOS +You can install `zellij` with [Homebrew on MacOS](https://formulae.brew.sh/formula/zellij): + +``` +brew install zellij +``` + +Or install with [MacPorts](https://ports.macports.org/port/zellij/details/): + +``` +port install zellij +``` \ No newline at end of file