Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add build instructions #118

Merged
merged 1 commit into from
Feb 16, 2025
Merged

docs: Add build instructions #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
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
Loading