From 6ea3f9186f9039650356b51fde4e70603d2ecef5 Mon Sep 17 00:00:00 2001 From: DecDuck Date: Tue, 8 Oct 2024 01:04:03 +1100 Subject: [PATCH] README update --- desktop/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/desktop/README.md b/desktop/README.md index cc7001af..aa3ac2d6 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -1 +1,12 @@ -# Drop App \ No newline at end of file +# Drop App + +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. + +## Development + +Install dependencies with `yarn` + +Run the app in development with `yarn tauri dev`. NVIDIA users on Linux, use the environment variable in `.env` + +## Contributing +Check the original Drop repo for contributing guidelines. \ No newline at end of file