From cff95dae73df6b05b4e552ed47eb828a4f65df59 Mon Sep 17 00:00:00 2001
From: Sau1707 <Sau1707@users.noreply.github.com>
Date: Tue, 24 Mar 2026 15:29:06 +0100
Subject: [PATCH] Added README with build instructions

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..e863dec98
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# COSMIC Applets Development
+
+This repository is a Rust workspace for COSMIC panel applets and panel buttons.
+
+## Install Build Dependencies
+
+On Debian or Ubuntu
+
+```bash
+sudo apt build-dep .
+```
+
+## Getting Started
+
+
+A [justfile](./justfile) is included by default with common recipes used by other COSMIC projects. Install from [casey/just][just]
+
+- `just` builds the application with the default `just build-release` recipe
+- `sudo just install` installs the project into the system
+- `just vendor` creates a vendored tarball
+- `just build-vendored` compiles with vendored dependencies from that tarball
+- `just check` runs clippy on the project to check for linter warnings
+- `just check-json` can be used by IDEs that support LSP
+
+
+## Reload The Current Applets
+
+After installing a new build, restart the panel so COSMIC relaunches the applets:
+
+```bash
+systemctl --user restart cosmic-session.target
+pkill cosmic-panel
+```
+
+You can also restore the packaged version by reinstalling the distro package:
+
+```bash
+sudo apt install --reinstall cosmic-applets
+pkill cosmic-panel
+```