mirror of
https://github.com/wez/wezterm.git
synced 2024-12-23 05:12:40 +03:00
docs: split install page into pages by platform
This commit is contained in:
Wez Furlong
parent
8ff9340d2f
commit
d6a5d1c835
1
.gitignore
vendored
1
.gitignore
vendored
@ -8,6 +8,7 @@
|
||||
/target/
|
||||
/gh_pages/
|
||||
/docs/installation.md
|
||||
/docs/install/*.md
|
||||
**/*.rs.bk
|
||||
.*.sw*
|
||||
/esctest.log
|
||||
|
||||
@ -78,8 +78,9 @@ def load_release_info():
|
||||
build_subst(subst, "nightly", nightly)
|
||||
print(pretty(subst))
|
||||
|
||||
with open("docs/installation.markdown", "r") as input:
|
||||
with open("docs/installation.md", "w") as output:
|
||||
for name in ['installation', 'install/windows', 'install/macos', 'install/linux', 'install/source']:
|
||||
with open(f"docs/{name}.markdown", "r") as input:
|
||||
with open(f"docs/{name}.md", "w") as output:
|
||||
for line in input:
|
||||
for (search, replace) in subst.items():
|
||||
line = line.replace(search, replace)
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
[wezterm](index.markdown)
|
||||
- [Install](installation.md)
|
||||
- [Windows](install/windows.md)
|
||||
- [macOS](install/macos.md)
|
||||
- [Linux](install/linux.md)
|
||||
- [Build from source](install/source.md)
|
||||
- [Features](features.markdown)
|
||||
- [Change Log](changelog.markdown)
|
||||
- [Configuration](config/files.markdown)
|
||||
|
||||
94
docs/install/linux.markdown
Normal file
94
docs/install/linux.markdown
Normal file
@ -0,0 +1,94 @@
|
||||
## Installing on Linux using AppImage
|
||||
|
||||
WezTerm is available in [AppImage](https://appimage.org/) format; a
|
||||
self-contained single file that doesn't require installation or
|
||||
any special privileges to run.
|
||||
|
||||
Download and make the file executable and you're ready to run!
|
||||
|
||||
<a href="{{ ubuntu16_AppImage_stable }}" class="btn">AppImage</a>
|
||||
<a href="{{ ubuntu16_AppImage_nightly }}" class="btn">Nightly AppImage</a>
|
||||
|
||||
```bash
|
||||
curl -LO {{ ubuntu16_AppImage_stable }}
|
||||
chmod +x {{ ubuntu16_AppImage_stable_asset }}
|
||||
```
|
||||
|
||||
You may then execute the appimage directly to launch wezterm, with no
|
||||
specific installation steps required:
|
||||
|
||||
```bash
|
||||
./{{ ubuntu16_AppImage_stable_asset }}
|
||||
```
|
||||
|
||||
That said, you may wish to make it a bit more convenient:
|
||||
|
||||
```bash
|
||||
mkdir ~/bin
|
||||
mv ./{{ ubuntu16_AppImage_stable_asset }} ~/bin/wezterm
|
||||
~/bin/wezterm
|
||||
```
|
||||
|
||||
* Configuration instructions can be [found here](../config/files.html)
|
||||
|
||||
## Installing on Ubuntu and Debian-based Systems
|
||||
|
||||
The CI system builds `.deb` files for a variety of Ubuntu and Debian distributions.
|
||||
These are often compatible with other Debian style systems; if you don't find one
|
||||
that exactly matches your system you can try installing one from an older version
|
||||
of your distribution, or use one of the Debian packages linked below. Failing that,
|
||||
you can try the AppImage download which should work on most Linux systems.
|
||||
|
||||
|Distro | Stable | Nightly |
|
||||
|------------|------------------|---------------------|
|
||||
|Ubuntu16 |[{{ ubuntu16_deb_stable_asset }}]({{ ubuntu16_deb_stable }}) |[{{ ubuntu16_deb_nightly_asset }}]({{ ubuntu16_deb_nightly }})|
|
||||
|Ubuntu18 |[{{ ubuntu18_deb_stable_asset }}]({{ ubuntu18_deb_stable }}) |[{{ ubuntu18_deb_nightly_asset }}]({{ ubuntu18_deb_nightly }})|
|
||||
|Ubuntu19 |[{{ ubuntu19_deb_stable_asset }}]({{ ubuntu19_deb_stable }}) |[{{ ubuntu19_deb_nightly_asset }}]({{ ubuntu19_deb_nightly }})|
|
||||
|Ubuntu20 |[{{ ubuntu20_deb_stable_asset }}]({{ ubuntu20_deb_stable }}) |[{{ ubuntu20_deb_nightly_asset }}]({{ ubuntu20_deb_nightly }})|
|
||||
|Debian9 |[{{ debian9_deb_stable_asset }}]({{ debian9_deb_stable }}) |[{{ debian9_deb_nightly_asset }}]({{ debian9_deb_nightly }})|
|
||||
|Debian10 |[{{ debian10_deb_stable_asset }}]({{ debian10_deb_stable }}) |[{{ debian10_deb_nightly_asset }}]({{ debian10_deb_nightly }})|
|
||||
|
||||
To download and install from the CLI, you can use something like this, which
|
||||
shows how to install the Ubuntu 16 package:
|
||||
|
||||
```bash
|
||||
curl -LO {{ ubuntu16_deb_stable }}
|
||||
sudo apt install -y ./{{ ubuntu16_deb_stable_asset }}
|
||||
```
|
||||
|
||||
* The package installs `/usr/bin/wezterm` and `/usr/share/applications/org.wezfurlong.wezterm.desktop`
|
||||
* Configuration instructions can be [found here](../config/files.html)
|
||||
|
||||
## Installing on Fedora and rpm-based Systems
|
||||
|
||||
The CI system builds `.rpm` files on CentOS and Fedora systems.
|
||||
These are likely compatible with other rpm-based distributions.
|
||||
Alternatively, you can try the AppImage download with should work
|
||||
on most Linux systems.
|
||||
|
||||
|Distro | Stable | Nightly |
|
||||
|------------|------------------|---------------------|
|
||||
|CentOS7 |[{{ centos7_rpm_stable_asset }}]({{ centos7_rpm_stable }}) |[{{ centos7_rpm_nightly_asset }}]({{ centos7_rpm_nightly }})|
|
||||
|CentOS8 |[{{ centos8_rpm_stable_asset }}]({{ centos8_rpm_stable }}) |[{{ centos8_rpm_nightly_asset }}]({{ centos8_rpm_nightly }})|
|
||||
|Fedora31 |[{{ fedora31_rpm_stable_asset }}]({{ fedora31_rpm_stable }}) |[{{ fedora31_rpm_nightly_asset }}]({{ fedora31_rpm_nightly }})|
|
||||
|Fedora32 |[{{ fedora32_rpm_stable_asset }}]({{ fedora32_rpm_stable }}) |[{{ fedora32_rpm_nightly_asset }}]({{ fedora32_rpm_nightly }})|
|
||||
|
||||
To download and install form the CLI you can use something like this, which
|
||||
shows how to install the Fedora 31 package:
|
||||
|
||||
```bash
|
||||
sudo dnf install -y {{ fedora31_rpm_stable }}
|
||||
```
|
||||
|
||||
* The package installs `/usr/bin/wezterm` and `/usr/share/applications/org.wezfurlong.wezterm.desktop`
|
||||
* Configuration instructions can be [found here](../config/files.html)
|
||||
|
||||
## Raw Linux Binary
|
||||
|
||||
Another option for linux is a raw binary archive. These are the same binaries that
|
||||
are built for Ubuntu but provided in a tarball.
|
||||
|
||||
<a href="{{ linux_raw_bin_stable }}" class="btn">Download raw Linux binaries</a>
|
||||
<a href="{{ linux_raw_bin_nightly }}" class="btn">Nightly raw Linux binaries</a>
|
||||
|
||||
|
||||
15
docs/install/macos.markdown
Normal file
15
docs/install/macos.markdown
Normal file
@ -0,0 +1,15 @@
|
||||
## Installing on macOS
|
||||
|
||||
The CI system builds the package on macOS Mojave (10.14). It may run on earlier
|
||||
versions of macOS, but that has not been tested.
|
||||
|
||||
<a href="{{ macos_zip_stable }}" class="btn">Download for macOS</a>
|
||||
<a href="{{ macos_zip_nightly }}" class="btn">Nightly for macOS</a>
|
||||
1. Download <a href="{{ macos_zip_stable }}">Release</a>
|
||||
2. Extract the zipfile and drag the `WezTerm.app` bundle to your `Applications` folder
|
||||
3. First time around, you may need to right click and select `Open` to allow launching
|
||||
the application that your just downloaded from the internet.
|
||||
3. Subsequently, a simple double-click will launch the UI
|
||||
4. Configuration instructions can be [found here](../config/files.html)
|
||||
|
||||
|
||||
43
docs/install/source.markdown
Normal file
43
docs/install/source.markdown
Normal file
@ -0,0 +1,43 @@
|
||||
## Installing from source
|
||||
|
||||
If your system isn't covered by the pre-built packages then you can build it
|
||||
for yourself. WezTerm should run on any modern unix as well as Windows 10 and
|
||||
macOS.
|
||||
|
||||
* Install `rustup` to get the `rust` compiler installed on your system.
|
||||
[Install rustup](https://www.rust-lang.org/en-US/install.html)
|
||||
* Rust version 1.41 or later is required
|
||||
* Build in release mode: `cargo build --release`
|
||||
* Run it via either `cargo run --release` or `target/release/wezterm`
|
||||
|
||||
You will need a collection of support libraries; the [`get-deps`](https://github.com/wez/wezterm/blob/master/get-deps) script will
|
||||
attempt to install them for you. If it doesn't know about your system,
|
||||
[please contribute instructions!](https://github.com/wez/wezterm/blob/master/CONTRIBUTING.md)
|
||||
|
||||
If you don't plan to submit a pull request to the wezterm repo, you can
|
||||
download a smaller source tarball using these steps:
|
||||
|
||||
```bash
|
||||
curl https://sh.rustup.rs -sSf | sh -s
|
||||
curl -LO {{ src_stable }}
|
||||
tar -xzf {{ src_stable_asset }}
|
||||
cd {{ src_stable_dir }}
|
||||
sudo ./get-deps
|
||||
cargo build --release
|
||||
cargo run --release -- start
|
||||
```
|
||||
|
||||
Alternatively, use the full git repo:
|
||||
|
||||
```bash
|
||||
curl https://sh.rustup.rs -sSf | sh -s
|
||||
git clone --depth=1 --branch=master --recursive https://github.com/wez/wezterm.git
|
||||
cd wezterm
|
||||
git submodule update --init --recursive
|
||||
sudo ./get-deps
|
||||
cargo build --release
|
||||
cargo run --release -- start
|
||||
```
|
||||
|
||||
**If you get an error about zlib then you most likely didn't initialize the submodules;
|
||||
take a closer look at the instructions!**
|
||||
40
docs/install/windows.markdown
Normal file
40
docs/install/windows.markdown
Normal file
@ -0,0 +1,40 @@
|
||||
## Installing on Windows
|
||||
|
||||
64-bit Windows 10.0.17763 or later is required to run WezTerm. You can download
|
||||
a setup.exe style installer to guide the installation (requires admin privileges)
|
||||
or a simple zip file and manage the files for yourself (no special privileges
|
||||
required).
|
||||
|
||||
<a href="{{ windows_exe_nightly }}" class="btn">Nightly for Windows (setup.exe)</a>
|
||||
|
||||
WezTerm is available in a setup.exe style installer; the installer is produced
|
||||
with Inno Setup and will install wezterm to your program files directory and
|
||||
register that location in your PATH environment. The installer can be run
|
||||
as a GUI to guide you through the install, but also offers the [standard
|
||||
Inno Setup command line options](https://jrsoftware.org/ishelp/index.php?topic=setupcmdline)
|
||||
to configure/script the installation process.
|
||||
|
||||
<a href="{{ windows_zip_stable }}" class="btn">Download for Windows (zip)</a>
|
||||
<a href="{{ windows_zip_nightly }}" class="btn">Nightly for Windows (zip)</a>
|
||||
|
||||
WezTerm is also available in a simple zip file that can be extracted and
|
||||
run from anywhere, including a flash drive for a portable/relocatable
|
||||
installation.
|
||||
|
||||
1. Download <a href="{{ windows_zip_stable }}">Release</a>
|
||||
2. Extract the zipfile and double-click `wezterm.exe` to run the UI
|
||||
3. Configuration instructions can be [found here](config/files.html)
|
||||
|
||||
### For `Scoop` users
|
||||
|
||||
If you prefer to use the command line to manage installing software,
|
||||
then you may wish to try [Scoop](https://scoop.sh/).
|
||||
|
||||
Wezterm is available from the "Extras" bucket and once you have installed
|
||||
scoop itself can be installed like so:
|
||||
|
||||
```bash
|
||||
scoop bucket add extras
|
||||
scoop install wezterm
|
||||
```
|
||||
|
||||
@ -1,187 +1,8 @@
|
||||
Wezterm is available pre-built for the major platforms and, because it is open
|
||||
source, you may also build it for yourself.
|
||||
|
||||
## Installing on Windows
|
||||
- [Windows](install/windows.md)
|
||||
- [macOS](install/macos.md)
|
||||
- [Linux](install/linux.md)
|
||||
- [Build from source](install/source.md)
|
||||
|
||||
64-bit Windows 10.0.17763 or later is required to run WezTerm. You can download
|
||||
a setup.exe style installer to guide the installation (requires admin privileges)
|
||||
or a simple zip file and manage the files for yourself (no special privileges
|
||||
required).
|
||||
|
||||
<a href="{{ windows_exe_nightly }}" class="btn">Nightly for Windows (setup.exe)</a>
|
||||
|
||||
WezTerm is available in a setup.exe style installer; the installer is produced
|
||||
with Inno Setup and will install wezterm to your program files directory and
|
||||
register that location in your PATH environment. The installer can be run
|
||||
as a GUI to guide you through the install, but also offers the [standard
|
||||
Inno Setup command line options](https://jrsoftware.org/ishelp/index.php?topic=setupcmdline)
|
||||
to configure/script the installation process.
|
||||
|
||||
<a href="{{ windows_zip_stable }}" class="btn">Download for Windows (zip)</a>
|
||||
<a href="{{ windows_zip_nightly }}" class="btn">Nightly for Windows (zip)</a>
|
||||
|
||||
WezTerm is also available in a simple zip file that can be extracted and
|
||||
run from anywhere, including a flash drive for a portable/relocatable
|
||||
installation.
|
||||
|
||||
1. Download <a href="{{ windows_zip_stable }}">Release</a>
|
||||
2. Extract the zipfile and double-click `wezterm.exe` to run the UI
|
||||
3. Configuration instructions can be [found here](config/files.html)
|
||||
|
||||
### For `Scoop` users
|
||||
|
||||
If you prefer to use the command line to manage installing software,
|
||||
then you may wish to try [Scoop](https://scoop.sh/).
|
||||
|
||||
Wezterm is available from the "Extras" bucket and once you have installed
|
||||
scoop itself can be installed like so:
|
||||
|
||||
```bash
|
||||
scoop bucket add extras
|
||||
scoop install wezterm
|
||||
```
|
||||
|
||||
## Installing on macOS
|
||||
|
||||
The CI system builds the package on macOS Mojave (10.14). It may run on earlier
|
||||
versions of macOS, but that has not been tested.
|
||||
|
||||
<a href="{{ macos_zip_stable }}" class="btn">Download for macOS</a>
|
||||
<a href="{{ macos_zip_nightly }}" class="btn">Nightly for macOS</a>
|
||||
1. Download <a href="{{ macos_zip_stable }}">Release</a>
|
||||
2. Extract the zipfile and drag the `WezTerm.app` bundle to your `Applications` folder
|
||||
3. First time around, you may need to right click and select `Open` to allow launching
|
||||
the application that your just downloaded from the internet.
|
||||
3. Subsequently, a simple double-click will launch the UI
|
||||
4. Configuration instructions can be [found here](config/files.html)
|
||||
|
||||
## Installing on Linux using AppImage
|
||||
|
||||
WezTerm is available in [AppImage](https://appimage.org/) format; a
|
||||
self-contained single file that doesn't require installation or
|
||||
any special privileges to run.
|
||||
|
||||
Download and make the file executable and you're ready to run!
|
||||
|
||||
<a href="{{ ubuntu16_AppImage_stable }}" class="btn">AppImage</a>
|
||||
<a href="{{ ubuntu16_AppImage_nightly }}" class="btn">Nightly AppImage</a>
|
||||
|
||||
```bash
|
||||
curl -LO {{ ubuntu16_AppImage_stable }}
|
||||
chmod +x {{ ubuntu16_AppImage_stable_asset }}
|
||||
```
|
||||
|
||||
You may then execute the appimage directly to launch wezterm, with no
|
||||
specific installation steps required:
|
||||
|
||||
```bash
|
||||
./{{ ubuntu16_AppImage_stable_asset }}
|
||||
```
|
||||
|
||||
That said, you may wish to make it a bit more convenient:
|
||||
|
||||
```bash
|
||||
mkdir ~/bin
|
||||
mv ./{{ ubuntu16_AppImage_stable_asset }} ~/bin/wezterm
|
||||
~/bin/wezterm
|
||||
```
|
||||
|
||||
* Configuration instructions can be [found here](config/files.html)
|
||||
|
||||
## Installing on Ubuntu and Debian-based Systems
|
||||
|
||||
The CI system builds `.deb` files for a variety of Ubuntu and Debian distributions.
|
||||
These are often compatible with other Debian style systems; if you don't find one
|
||||
that exactly matches your system you can try installing one from an older version
|
||||
of your distribution, or use one of the Debian packages linked below. Failing that,
|
||||
you can try the AppImage download which should work on most Linux systems.
|
||||
|
||||
|Distro | Stable | Nightly |
|
||||
|------------|------------------|---------------------|
|
||||
|Ubuntu16 |[{{ ubuntu16_deb_stable_asset }}]({{ ubuntu16_deb_stable }}) |[{{ ubuntu16_deb_nightly_asset }}]({{ ubuntu16_deb_nightly }})|
|
||||
|Ubuntu18 |[{{ ubuntu18_deb_stable_asset }}]({{ ubuntu18_deb_stable }}) |[{{ ubuntu18_deb_nightly_asset }}]({{ ubuntu18_deb_nightly }})|
|
||||
|Ubuntu19 |[{{ ubuntu19_deb_stable_asset }}]({{ ubuntu19_deb_stable }}) |[{{ ubuntu19_deb_nightly_asset }}]({{ ubuntu19_deb_nightly }})|
|
||||
|Ubuntu20 |[{{ ubuntu20_deb_stable_asset }}]({{ ubuntu20_deb_stable }}) |[{{ ubuntu20_deb_nightly_asset }}]({{ ubuntu20_deb_nightly }})|
|
||||
|Debian9 |[{{ debian9_deb_stable_asset }}]({{ debian9_deb_stable }}) |[{{ debian9_deb_nightly_asset }}]({{ debian9_deb_nightly }})|
|
||||
|Debian10 |[{{ debian10_deb_stable_asset }}]({{ debian10_deb_stable }}) |[{{ debian10_deb_nightly_asset }}]({{ debian10_deb_nightly }})|
|
||||
|
||||
To download and install from the CLI, you can use something like this, which
|
||||
shows how to install the Ubuntu 16 package:
|
||||
|
||||
```bash
|
||||
curl -LO {{ ubuntu16_deb_stable }}
|
||||
sudo apt install -y ./{{ ubuntu16_deb_stable_asset }}
|
||||
```
|
||||
|
||||
* The package installs `/usr/bin/wezterm` and `/usr/share/applications/org.wezfurlong.wezterm.desktop`
|
||||
* Configuration instructions can be [found here](config/files.html)
|
||||
|
||||
## Installing on Fedora and rpm-based Systems
|
||||
|
||||
The CI system builds `.rpm` files on CentOS and Fedora systems.
|
||||
These are likely compatible with other rpm-based distributions.
|
||||
Alternatively, you can try the AppImage download with should work
|
||||
on most Linux systems.
|
||||
|
||||
|Distro | Stable | Nightly |
|
||||
|------------|------------------|---------------------|
|
||||
|CentOS7 |[{{ centos7_rpm_stable_asset }}]({{ centos7_rpm_stable }}) |[{{ centos7_rpm_nightly_asset }}]({{ centos7_rpm_nightly }})|
|
||||
|CentOS8 |[{{ centos8_rpm_stable_asset }}]({{ centos8_rpm_stable }}) |[{{ centos8_rpm_nightly_asset }}]({{ centos8_rpm_nightly }})|
|
||||
|Fedora31 |[{{ fedora31_rpm_stable_asset }}]({{ fedora31_rpm_stable }}) |[{{ fedora31_rpm_nightly_asset }}]({{ fedora31_rpm_nightly }})|
|
||||
|Fedora32 |[{{ fedora32_rpm_stable_asset }}]({{ fedora32_rpm_stable }}) |[{{ fedora32_rpm_nightly_asset }}]({{ fedora32_rpm_nightly }})|
|
||||
|
||||
To download and install form the CLI you can use something like this, which
|
||||
shows how to install the Fedora 31 package:
|
||||
|
||||
```bash
|
||||
sudo dnf install -y {{ fedora31_rpm_stable }}
|
||||
```
|
||||
|
||||
* The package installs `/usr/bin/wezterm` and `/usr/share/applications/org.wezfurlong.wezterm.desktop`
|
||||
* Configuration instructions can be [found here](config/files.html)
|
||||
|
||||
## Raw Linux Binary
|
||||
|
||||
Another option for linux is a raw binary archive. These are the same binaries that
|
||||
are built for Ubuntu but provided in a tarball.
|
||||
|
||||
<a href="{{ linux_raw_bin_stable }}" class="btn">Download raw Linux binaries</a>
|
||||
<a href="{{ linux_raw_bin_nightly }}" class="btn">Nightly raw Linux binaries</a>
|
||||
|
||||
## Installing from source
|
||||
|
||||
If your system isn't covered by the list above, then you can build it for yourself.
|
||||
WezTerm should run on any modern unix as well as Windows 10 and macOS.
|
||||
|
||||
* Install `rustup` to get the `rust` compiler installed on your system.
|
||||
[Install rustup](https://www.rust-lang.org/en-US/install.html)
|
||||
* Rust version 1.41 or later is required
|
||||
* Build in release mode: `cargo build --release`
|
||||
* Run it via either `cargo run --release` or `target/release/wezterm`
|
||||
|
||||
You will need a collection of support libraries; the [`get-deps`](https://github.com/wez/wezterm/blob/master/get-deps) script will
|
||||
attempt to install them for you. If it doesn't know about your system,
|
||||
[please contribute instructions!](https://github.com/wez/wezterm/blob/master/CONTRIBUTING.md)
|
||||
|
||||
If you don't plan to submit a pull request to the wezterm repo, you can
|
||||
download a smaller source tarball using these steps:
|
||||
|
||||
```bash
|
||||
curl https://sh.rustup.rs -sSf | sh -s
|
||||
curl -LO {{ src_stable }}
|
||||
tar -xzf {{ src_stable_asset }}
|
||||
cd {{ src_stable_dir }}
|
||||
sudo ./get-deps
|
||||
cargo build --release
|
||||
cargo run --release -- start
|
||||
```
|
||||
|
||||
Alternatively, use the full git repo:
|
||||
|
||||
```bash
|
||||
curl https://sh.rustup.rs -sSf | sh -s
|
||||
git clone --depth=1 --branch=master --recursive https://github.com/wez/wezterm.git
|
||||
cd wezterm
|
||||
git submodule update --init --recursive
|
||||
sudo ./get-deps
|
||||
cargo build --release
|
||||
cargo run --release -- start
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user