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.

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

Changed README.md to add Linux build and run support #79

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
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
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ Before contributing please read the [contributing guidelines](./CONTRIBUTING.md)

## Supported operating systems
- Windows
- Linux (tested on Ubuntu 22.04 LTS)

There are some issues with Linux and Mac but we shall work on these soon.
More testing with different Linux distributions is required to ensure compatibillity across all of them.

Bear in mind this is still in development and missing the following core features:
- Caching service (constant file watching to keep cache up to date) - only works when program is open
Expand All @@ -32,7 +34,7 @@ Bear in mind this is still in development and missing the following core feature
# Make sure you have Tauri CLI installed
cargo install tauri-cli

# Install dependencies
# Install Web dependencies
yarn

# Run app for development
Expand All @@ -41,3 +43,38 @@ cargo tauri dev
# Build for production
cargo tauri build
```
## Steps for Debian-like distributions (Tauri v1.3)
```
# Make sure you have Tauri CLI installed
cargo install tauri-cli

# Install Web dependencies
yarn

# Install Tauri dependencies (for runtime and building)
sudo apt update
sudo apt install libwebkit2gtk-4.0-dev \
build-essential \
curl \
wget \
file \
libssl-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev

# Run app for development
cargo tauri dev

# Build for production
cargo tauri build

```

**NOTE: For all `cargo tauri` commands, run the commands in a terminal outside an IDE or text editor, because there is an issue where some IDEs and text editors set the $GTK_PATH to a custom folder. Causing `cargo tauri dev` and `cargo tauri build` to not work properly.**

**Running the application binary from a terminal in an IDE or text editor also causes the application to not work properly**