1
1
mirror of https://github.com/wez/wezterm.git synced 2024-09-20 11:17:15 +03:00

tweak download/install instructions to use release metadata

This commit is contained in:
Wez Furlong 2019-06-23 18:12:26 -07:00
parent 3b26e7ad35
commit 196a64405a
7 changed files with 77 additions and 12 deletions

View File

@ -1,3 +1,4 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem 'jekyll-redirect-from'
gem 'jekyll-octicons'

View File

@ -124,6 +124,9 @@ GEM
jekyll-mentions (1.4.1)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-octicons (9.1.1)
jekyll (~> 3.1)
octicons (= 9.1.1)
jekyll-optional-front-matter (0.3.0)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
@ -207,6 +210,8 @@ GEM
multipart-post (2.1.1)
nokogiri (1.10.3)
mini_portile2 (~> 2.4.0)
octicons (9.1.1)
nokogiri (>= 1.6.3.1)
octokit (4.14.0)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
@ -243,6 +248,7 @@ PLATFORMS
DEPENDENCIES
github-pages
jekyll-octicons
jekyll-redirect-from
BUNDLED WITH

View File

@ -1 +1,3 @@
theme: jekyll-theme-primer
gems:
- jekyll-octicons

View File

@ -27,10 +27,8 @@
display:inline-block;
cursor:pointer;
color:#ffffff;
font-family:Arial;
font-size:15px;
font-weight:bold;
padding:6px 24px;
padding:0.25em 1em;
text-decoration:none;
text-shadow:0px 1px 0px #9b14b3;
}
@ -48,6 +46,12 @@
position:relative;
top:1px;
}
svg.octicon {
margin-right: 0.25em;
}
a.btn svg {
fill: white;
}
</style>

View File

@ -2,7 +2,7 @@
title: Feature list | Wez's Terminal
---
## Available Features
## {% octicon list-unordered height:24 %} Available Features
* Runs on Linux, macOS and Windows 10
* [Multiplex terminal tabs and windows on local and remote hosts, with native mouse and scrollback](multiplexing.html)

View File

@ -5,8 +5,19 @@ title: Wez's Terminal
*A GPU-accelerated cross-platform terminal emulator and multiplexer written by <a href="https://github.com/wez/">@wez</a> and implemented in <a href="https://www.rust-lang.org/">Rust</a>*
<div>
<a href="https://github.com/wez/wezterm/releases/latest" class="btn" style="margin-right:1em"
>Download</a> <a href="installation.html">installation instructions</a>
{% for asset in site.github.latest_release.assets %}
{% if asset.name contains 'azure' %}
{% if asset.name contains 'windows' %}
<a href="{{ asset.browser_download_url }}" class="btn" style="margin-right:1em">{% octicon cloud-download %} Download for Windows</a>
{% endif %}
{% if asset.name contains 'macos' %}
<a href="{{ asset.browser_download_url }}" class="btn" style="margin-right:1em">{% octicon cloud-download %} Download for macOS</a>
{% endif %}
{% endif %}
{% endfor %}
<a href="installation.html">Linux and other installation instructions</a>
</div>
## Features

View File

@ -2,15 +2,57 @@
title: Installation
---
## Installing a package
## {% octicon cloud-download height:24 %} Installing a pre-built package on Windows
* Linux, macOS and Windows packages are available from [the Releases page](https://github.com/wez/wezterm/releases)
* Bleeding edge Windows package available from [Appveyor](https://ci.appveyor.com/project/wez/wezterm/build/artifacts?branch=master)
Windows 10 or later is required to run WezTerm.
## Installing from source
{% for asset in site.github.latest_release.assets %}
{% if asset.name contains 'azure' and asset.name contains 'windows' %}
1. Download <a href="{{ asset.browser_download_url }}">{{ asset.name }}</a>
2. Extract the zipfile and double-click `wezterm.exe` to run the UI
3. Configuration instructions can be [found here](configuration.html)
{% endif %}
{% endfor %}
## {% octicon cloud-download height:24 %} Installing a pre-built package 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.
{% for asset in site.github.latest_release.assets %}
{% if asset.name contains 'azure' and asset.name contains 'macos' %}
1. Download <a href="{{ asset.browser_download_url }}">{{ asset.name }}</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](configuration.html)
{% endif %}
{% endfor %}
## {% octicon cloud-download height:24 %} Installing a pre-built package on Ubuntu
The CI system builds a `.deb` file on Ubuntu 16.04. It may be compatible with other
debian style systems.
{% for asset in site.github.latest_release.assets %}
{% if asset.name contains '.deb' %}
* <tt>curl -LO <a href="{{ asset.browser_download_url }}">{{ asset.browser_download_url }}</a></tt>
* `sudo dpkg -i {{ asset.name }}`
* The package installs `/usr/bin/wezterm`
* Configuration instructions can be [found here](configuration.html)
{% endif %}
{% endfor %}
## {% octicon beaker height:24 %} Nightly builds
Bleeding edge nightly pre-release builds may be available from [the releases page](https://github.com/wez/wezterm/releases).
## {% octicon git-branch height:24 %} Installing from source
* Install `rustup` to get the `rust` compiler installed on your system.
https://www.rust-lang.org/en-US/install.html
[Install rustup](https://www.rust-lang.org/en-US/install.html)
* Rust version 1.35 or later is required
* Build in release mode: `cargo build --release`
* Run it via either `cargo run --release` or `target/release/wezterm`
@ -29,4 +71,3 @@ $ cargo build --release
$ cargo run --release -- start
```