From 05807bc8cff0bff2cad084ece723f84444457a3c Mon Sep 17 00:00:00 2001 From: hrzlgnm Date: Mon, 21 Oct 2024 22:52:00 +0200 Subject: [PATCH 1/2] docs: overhaul readme and building instructions --- BUILDING.md | 4 ++-- README.md | 58 ++++++++++++++++++++++++++++++++++++++++------------- 2 files changed, 46 insertions(+), 16 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index fd74c94..6047e45 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -2,7 +2,7 @@ ## Prerequisites -More information is available in [Tauri-Prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites/#setting-up-linux) +More information is available in [Tauri-Prerequisites](https://tauri.app/start/prerequisites/) ### Additional targets for rust @@ -20,7 +20,7 @@ rustup target add wasm32-unknown-unknown Installation using package-manager -See also official [tauri-instructions](https://tauri.app/v1/guides/getting-started/prerequisites/#setting-up-linux) +See also official [tauri-instructions](https://tauri.app/start/prerequisites/#linux) #### xbps diff --git a/README.md b/README.md index 22a08d2..576aa3e 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,64 @@ # mDNS-Browser +This application allows you to browse services using mDNS. + -- [mDNS-Browser](#mdns-browser) - - [Building](#building) - - [Where EXE?](#where-exe) - - [github releases](#github-releases) - - [winget](#winget) +- [mDNS-Browser Overview](#mdns-browser) + - [How to Build](#building) + - [Where to find the executables?](#where-to-find-the-executables) + - [GitHub Release](#github-releases) + - [Winget Installation](#winget-installation) + - [Arch Linux (AUR)](#arch-linux-aur) - [Acknowledgments](#acknowledgments) -This app allows for browsing of services using mDNS - ## Building -See [BUILDING](BUILDING.md) document. +For instructions on building the application, checkout the [BUILDING](BUILDING.md) document. + +## Where to find the executables? -## Where EXE? +### GitHub Releases -### github releases +You can download the latest version of the application from the [GitHub Release page](https://github.com/hrzlgnm/mdns-browser/releases/latest) -The latest release can be downloaded here [Release](https://github.com/hrzlgnm/mdns-browser/releases/latest) +### Winget installation -### winget +To install via Winget, run the following command: ```console winget install mdns-browser ``` +### Arch Linux (AUR) + +To install on Arch Linux using the AUR, you can use an AUR helper like yay or paru: + +With `yay`: + +```console +yay -S mdns-browser +``` + +Alternatively using the -bin package: + +```console +yay -S mdns-browser-bin +``` + +With `paru`: + +```console +paru -S mdns-browser +``` + +Alternatively using the -bin package: + +```console +paru -S mdns-browser-bin +``` + ## Acknowledgments -The main workhorse of this application is the great library [mdns-sd](https://github.com/keepsimple1/mdns-sd) used to do all the mDNS magic happening in the backend of the app. -Consider giving the repo a star if you like this application. +This app uses the fantastic [mdns-sd library](https://github.com/keepsimple1/mdns-sd)to handle all mDNS functionality. If you find this app helpful, consider giving the library a star on GitHub! From 544165f0086dc9409182017fd02ae48382ac472e Mon Sep 17 00:00:00 2001 From: hrzlgnm Date: Mon, 21 Oct 2024 23:01:12 +0200 Subject: [PATCH 2/2] more friendly building istructions --- BUILDING.md | 61 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 38 insertions(+), 23 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 6047e45..b9809ca 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,50 +1,65 @@ -# Building instructions +# Building Instructions ## Prerequisites -More information is available in [Tauri-Prerequisites](https://tauri.app/start/prerequisites/) +Before you begin, make sure you meet the necessary prerequisites. You can find more details in the official [Tauri Guide](https://tauri.app/start/prerequisites/). -### Additional targets for rust +### Rust Additional Targets -- wasm32-unknown-unknown +You'll need to add an additional Rust target: -Installation using rustup +- **Target**: `wasm32-unknown-unknown` + +To install it, run the following command using `rustup`: ```console rustup target add wasm32-unknown-unknown ``` -### Development libraries +### Development Libraries + +Make sure the following development libraries are installed: -- wegkit2gkt-devel curl wget file openssl gtk+3-devel libsvg-devel gcc pkg-config +- `webkit2gtk-devel` +- `curl` +- `wget` +- `file` +- `openssl` +- `gtk+3-devel` +- `librsvg-devel` +- `gcc` +- `pkg-config` -Installation using package-manager +You can install these using your package manager. For detailed instructions, refer to the official [Tauri Linux setup guide](https://tauri.app/start/prerequisites/#linux). -See also official [tauri-instructions](https://tauri.app/start/prerequisites/#linux) +#### xbps (Void Linux) -#### xbps +For Void Linux, install these dependencies by running: ```console sudo xbps-install -Syu sudo xbps-install -S \ - webkit2gtk-devel \ - curl \ - wget \ - file \ - openssl \ - gtk+3-devel \ - librsvg-devel \ - gcc \ - pkg-config + webkit2gtk-devel \ + curl \ + wget \ + file \ + openssl \ + gtk+3-devel \ + librsvg-devel \ + gcc \ + pkg-config ``` -### Crates +### Rust Crates -- trunk -- tauri-cli +You'll also need the following Rust crates: -Those can be installed using cargo. +- `trunk` +- `tauri-cli` + +You can install them using `cargo` with the command: ```console cargo install --locked trunk tauri-cli + ```