Skip to content

Commit

Permalink
docs: Add build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jserv committed Feb 14, 2025
1 parent 17bd4dc commit 34636a9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 34636a9

Please sign in to comment.