Skip to content

Commit 31c4455

Browse files
Cameron AmerCameron Amer
authored andcommitted
docs: expand prerequisites with detailed dependencies and build instructions
1 parent 789217e commit 31c4455

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,27 @@ Telegram Drive leverages the Telegram API to allow you to upload, organize, and
5757
## Getting Started
5858

5959
### Prerequisites
60-
* Node.js (v18+)
61-
* Rust (latest stable) - Install via [rustup](https://rustup.rs/):
60+
61+
* **Node.js (v18+)**: [Download here](https://nodejs.org/)
62+
* **Rust (latest stable)**: Required to compile the Tauri backend. Install via [rustup](https://rustup.rs/):
6263
* **macOS/Linux:** `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
6364
* **Windows:** Download and run `rustup-init.exe` from [rustup.rs](https://rustup.rs/)
64-
* OS-Specific Build Tools for Tauri (e.g., `build-essential`, `libwebkit2gtk-4.1-dev` on Ubuntu, Visual Studio C++ Build Tools on Windows, Xcode on macOS). See [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) for full details.
65-
* A Telegram Account
66-
* API ID and Hash from [my.telegram.org](https://my.telegram.org)
65+
* *Verify installation:* run `rustc --version` and `cargo --version` in your terminal.
66+
* **OS-Specific Build Tools for Tauri**:
67+
* **macOS:** Xcode Command Line Tools (`xcode-select --install`).
68+
* **Linux (Ubuntu/Debian):** `sudo apt update && sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev`
69+
* **Windows (CRITICAL):** You **must** install the [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). During installation, select the **"Desktop development with C++"** workload. Without this, you will get a `linker 'link.exe' not found` error.
70+
* **Windows (WebView2):** Windows 10/11 users usually have this pre-installed. If not, download the [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section).
71+
* *Reference:* See the official [Tauri v2 Prerequisites Guide](https://v2.tauri.app/start/prerequisites/) for detailed instructions.
72+
* **Telegram API Credentials**: You need your own API ID and API Hash to communicate with Telegram's servers.
73+
1. Log into [my.telegram.org](https://my.telegram.org).
74+
2. Go to "API development tools" and create a new application to get your `api_id` and `api_hash`.
75+
76+
> [!NOTE]
77+
> **First-run Compile Time:** The initial build (`npm run tauri dev` or `npm run tauri build`) will download and compile over 300 Rust crates. This process can take **5 to 15 minutes** depending on your hardware. Subsequent builds will be much faster.
78+
79+
> [!TIP]
80+
> **NPM Vulnerabilities:** You may see vulnerability warnings during `npm install`. These are usually related to build tools and dev dependencies. You can optionally run `npm audit fix`, but it is not strictly required to run the app.
6781
6882
### Installation
6983

0 commit comments

Comments
 (0)