Document Gitea setup for Linux and Windows

2026-10-27 10:03:54 -04:00
1 changed files with 62 additions and 1 deletions
@@ -20,7 +20,8 @@ enthusiasts to share niche music. This repository is that client plus

 ***Quick install:***

-`curl -fsSL https://re-invention.nl/soulseek-rs/install.sh | sh`
+For this Gitea version, follow [Build and run from Gitea](#build-and-run-from-gitea)
+below. It includes the **Shift+D** shortcut to download a track's containing folder.



@@ -87,6 +88,66 @@ project is identifiable on the network.

 ## Installation

+### Build and run from Gitea
+
+You need access to this private Gitea repository and an internet connection to
+download the build dependencies.
+
+**Requirements**
+
+- **Linux:** Install Git and a C compiler/linker (`build-essential` on
+  Ubuntu/Debian), then install **Rust 1.91 or newer** using
+  [rustup](https://rust-lang.org/tools/install/).
+- **Windows:** Install [Git for Windows](https://git-scm.com/download/win)
+  and [Rust](https://rust-lang.org/tools/install/). Accept the prompt to
+  install Visual Studio C++ Build Tools, using the **Desktop development
+  with C++** workload. Reopen PowerShell after installation.
+
+**Download and build**
+
+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
+cd soulseek-rs-modded
+cargo build --release -p soulseek-rs
+```
+
+**Run on Linux**
+
+```sh
+./target/release/soulseek-rs
+```
+
+**Run on Windows (PowerShell)**
+
+```powershell
+.\target\release\soulseek-rs.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,
+including files absent from the search results. **Space** selects individual
+files and **Enter** downloads that selection. Press **?** for shortcuts or
+**q** to quit.
+
+**Update later**
+
+Close the application, run these commands inside `soulseek-rs-modded`, then
+launch it again with the command for your operating system:
+
+```sh
+git pull --ff-only
+cargo build --release -p soulseek-rs
+```
+
+### Upstream installation options
+
+The installers and packages below install the original upstream project.
+Use the Gitea build instructions above for this repository's modifications.
+
 The installer picks the right macOS or Linux binary, verifies its sha256, and
 installs the latest stable release (through Homebrew when it is available):