From 70cecdad196bbf8f53c746d1723c08f003fa0df7 Mon Sep 17 00:00:00 2001 From: DecDuck Date: Thu, 11 Sep 2025 08:16:33 +1000 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f66cea8..662712b 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,21 @@ -# Drop App +# Drop Desktop Client -Drop app is the companion app for [Drop](https://github.com/Drop-OSS/drop). It uses a Tauri base with Nuxt 3 + TailwindCSS on top of it, so we can re-use components from the web UI. +The Drop Desktop Client is the companion app for [Drop](https://github.com/Drop-OSS/drop). It is the official & intended way to download and play games on your Drop server. -## Running -Before setting up the drop app, be sure that you have a server set up. -The instructions for this can be found on the [Drop Docs](https://docs.droposs.org/docs/guides/quickstart) +## Internals -## Current features -Currently supported are the following features: -- Signin (with custom server) -- Database registering & recovery -- Dynamic library fetching from server -- Installing & uninstalling games -- Download progress monitoring -- Launching / playing games +It uses a Tauri base with Nuxt 3 + TailwindCSS on top of it, so we can re-use components from the web UI. ## Development +Before setting up a development environemnt, be sure that you have a server set up. The instructions for this can be found on the [Drop Docs](https://docs.droposs.org/docs/guides/quickstart). -Install dependencies with `yarn` +Then, install dependencies with `yarn`. This'll install the custom builder's dependencies. Then, check everything works properly with `yarn tauri build`. -Run the app in development with `yarn tauri dev`. NVIDIA users on Linux, use shell script `./nvidia-prop-dev.sh` +Run the app in development with `yarn tauri dev`. NVIDIA users on Linux, use shell script `./nvidia-prop-dev.sh` To manually specify the logging level, add the environment variable `RUST_LOG=[debug, info, warn, error]` to `yarn tauri dev`: e.g. `RUST_LOG=debug yarn tauri dev` ## Contributing -Check the original [Drop repo](https://github.com/Drop-OSS/drop/blob/main/CONTRIBUTING.md) for contributing guidelines. \ No newline at end of file +Check out the contributing guide on our Developer Docs: [Drop Developer Docs - Contributing](https://developer.droposs.org/contributing).