From 34636a9dac7f724704d677f2064cb246a7f8c6c2 Mon Sep 17 00:00:00 2001 From: Jim Huang Date: Fri, 14 Feb 2025 17:32:18 +0800 Subject: [PATCH] docs: Add build instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index cab3f9e..badfc0b 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,21 @@ Written in Rust, Webterm is built from the ground up for security, performance, _(Binary distributions and detailed installation instructions for more platforms are coming soon.)_ +## Build from source + +To build Webterm from source, you will need Rust and Cargo installed first. +If you have not already set them up, refer to [The Cargo Book](https://doc.rust-lang.org/cargo/getting-started/installation.html) for installation instructions. +Webterm also depends on OpenSSL, so confirm that it is installed on your system. +If you are on an Ubuntu/Debian-based platform and need to install OpenSSL, run: +```bash +sudo apt-get install libssl-dev +``` + +Once these prerequisites are in place, simply run: +```bash +cargo build +``` + ## Screenshots ![image](https://github.com/user-attachments/assets/06240ef7-e51d-4176-a957-87948688f8a6)