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
This commit is contained in:
parent
851bc863c1
commit
c35a6ba938
2 changed files with 40 additions and 2 deletions
|
|
@ -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.
|
||||
|
|
|
|||
37
THIRD_PARTY_INSTALL.md
Normal file
37
THIRD_PARTY_INSTALL.md
Normal file
|
|
@ -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.**
|
||||
|
||||
[](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
|
||||
```
|
||||
Loading…
Add table
Reference in a new issue