diff --git a/README.md b/README.md index 9fcd55f..e24c02a 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,10 @@ project is identifiable on the network. You need access to this private Gitea repository and an internet connection to download the build dependencies. +These instructions build the application from source. No prebuilt Windows +`.exe` has been provided for this modified version; cloning the repository +does not download an executable. + **Requirements** - **Linux:** Install Git and a C compiler/linker (`build-essential` on @@ -109,7 +113,7 @@ Run these commands in a Linux terminal or Windows PowerShell. Authenticate with Gitea when prompted. The first build may take several minutes. ```sh -git clone --branch develop https://git.bloggin.space/dumbgoy/soulseek-rs-modded.git +git clone --branch main https://git.bloggin.space/dumbgoy/soulseek-rs-modded.git cd soulseek-rs-modded cargo build --release -p soulseek-rs ``` @@ -122,10 +126,17 @@ cargo build --release -p soulseek-rs **Run on Windows (PowerShell)** +Run `cargo build --release -p soulseek-rs` **on Windows** first. After a +successful build, Cargo creates `target\release\soulseek-rs.exe`. Launch that +generated executable from the project directory: + ```powershell .\target\release\soulseek-rs.exe ``` +A normal Linux build produces `target/release/soulseek-rs`, a Linux binary; +it does not produce the Windows `.exe`. + Log in with your Soulseek account. Press **s** to search, enter your query, and press **Enter**. Focus the results pane with **2**, highlight a track, then press **Shift+D** to download all files directly in its remote folder,