Initial Commit

README.md

@@ -0,0 +1,41 @@
+# Decky
+
+Decky is a focused Windows desktop client for viewing and editing boards from a
+Nextcloud Deck instance.
+
+## Current status
+
+The repository currently contains:
+
+- `Decky.Core`, a UI-independent Deck REST API client and domain foundation;
+- `Decky.ApiSpike`, a read-only connection and compatibility probe;
+- `Decky.App`, the initial WinUI 3 desktop shell;
+- focused tests for API path discovery, required headers, update serialization,
+  completion clearing, color preservation, and text contrast.
+
+## Development
+
+Install the .NET 10 SDK and the Visual Studio WinUI application-development
+workload. Then run:
+
+```powershell
+dotnet restore Decky.slnx
+dotnet test tests/Decky.Core.Tests/Decky.Core.Tests.csproj
+dotnet run --project src/Decky.ApiSpike/Decky.ApiSpike.csproj
+```
+
+The compatibility probe prompts for a Nextcloud app password without echoing or
+storing it. It starts with read-only board, stack, and card-list requests. On a
+disposable test board, its explicitly confirmed `WRITE` mode also verifies card
+color creation/preservation, setting and clearing completion, same-stack reorder,
+cross-stack movement, response verification, and cleanup.
+
+The desktop app stores its JSON settings in `%LOCALAPPDATA%\Decky\settings.json`.
+The app password is stored separately in Windows Credential Locker and is never
+written to the JSON file.
+
+## Updates
+
+Release builds will be distributed as a signed MSIX bundle through a stable
+`Decky.appinstaller` feed. Forgejo is the source and CI/release host; installed
+copies do not update with `git pull`.