Add readme

2021-05-06 17:26:05 +02:00 · 2021-05-06 17:26:05 +02:00 · 0ae5c6da5f
parent 7673a9edcc
commit 0ae5c6da5f
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,11 @@
+# Vikunja Desktop for NixOS
+
+This repo contains a collection `.nix` files to build the [Vikunja frontend](https://code.vikunja.io/frontend) and the [electron-based desktop app](https://code.vikunja.io/desktop) for NixOS systems.
+
+## Building locally
+
+```
+cd desktop
+nix-build -E 'with import <nixpkgs> {}; callPackage ./default.nix {}'
+```
+