From 196a64405a409cab7ddab4f081ac18d4defe6526 Mon Sep 17 00:00:00 2001 From: Wez Furlong Date: Sun, 23 Jun 2019 18:12:26 -0700 Subject: [PATCH] tweak download/install instructions to use release metadata --- docs/Gemfile | 1 + docs/Gemfile.lock | 6 +++++ docs/_config.yml | 2 ++ docs/_layouts/default.html | 10 ++++--- docs/features.markdown | 2 +- docs/index.markdown | 15 +++++++++-- docs/installation.markdown | 53 +++++++++++++++++++++++++++++++++----- 7 files changed, 77 insertions(+), 12 deletions(-) diff --git a/docs/Gemfile b/docs/Gemfile index bcd3be7d0..0a0aabfac 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,3 +1,4 @@ source 'https://rubygems.org' gem 'github-pages', group: :jekyll_plugins gem 'jekyll-redirect-from' +gem 'jekyll-octicons' diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 6efb438bd..fce3d3399 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -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 diff --git a/docs/_config.yml b/docs/_config.yml index ee845eec8..26aa1fe5e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,3 @@ theme: jekyll-theme-primer +gems: + - jekyll-octicons diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 0b9a92b01..7ada8d70e 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -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; +} diff --git a/docs/features.markdown b/docs/features.markdown index 9862ea970..0e52adc8a 100644 --- a/docs/features.markdown +++ b/docs/features.markdown @@ -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) diff --git a/docs/index.markdown b/docs/index.markdown index f91ddd780..f815c7236 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -5,8 +5,19 @@ title: Wez's Terminal *A GPU-accelerated cross-platform terminal emulator and multiplexer written by @wez and implemented in Rust*
-Download installation instructions + +{% for asset in site.github.latest_release.assets %} + {% if asset.name contains 'azure' %} + {% if asset.name contains 'windows' %} + {% octicon cloud-download %} Download for Windows + {% endif %} + {% if asset.name contains 'macos' %} + {% octicon cloud-download %} Download for macOS + {% endif %} + {% endif %} +{% endfor %} + + Linux and other installation instructions
## Features diff --git a/docs/installation.markdown b/docs/installation.markdown index 0246ce576..b03834fbc 100644 --- a/docs/installation.markdown +++ b/docs/installation.markdown @@ -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 {{ asset.name }} +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 {{ asset.name }} +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' %} + +* curl -LO {{ asset.browser_download_url }} +* `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 ``` -