wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-10-05 18:58:52 +03:00
Code Issues Projects Releases Wiki Activity

docs: update with hints on building on Windows

Browse Source 
closes: #5528
This commit is contained in:
Wez Furlong 2024-06-09 09:50:24 -07:00
parent 11124f0cfe
commit f5e496ebc2
No known key found for this signature in database
GPG Key ID: 7A7F66A31EC9B387
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/install/source.md
View File

@ -5,14 +5,14 @@ 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)
[Install rustup](https://www.rust-lang.org/en-US/install.html).
* Rust version 1.71 or later is required
* Build in release mode: `cargo build --release`
* Run it via either `cargo run --release --bin wezterm` or `target/release/wezterm`
You will need a collection of support libraries; the [`get-deps`](https://github.com/wez/wezterm/blob/main/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/main/CONTRIBUTING.md)
[please contribute instructions!](https://github.com/wez/wezterm/blob/main/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:
@ -53,3 +53,19 @@ $ cargo build --release --no-default-features --features vendored-fonts
```
Building without X11 is not supported.
### Building on Windows
When installing Rust, you must use select the MSVC version of Rust. It is the
only supported way to build wezterm.
On Windows, instead of using `get-deps`, the only other dependency that you need is
[Strawberry Perl](https://strawberryperl.com). You must ensure that you have
your `PATH` environment set up to find that particular `perl.exe` ahead of any
other perl that you may have installed on your system. This particular version
of perl is required to build openssl on Windows.
```console
$ set PATH=c:\Strawberry\perl\bin;%PATH%
```