From 2ba34808ffbe49f01b82b07dfbf4faf0da713213 Mon Sep 17 00:00:00 2001
From: Raito Bezarius <masterancpp@gmail.com>
Date: Thu, 5 Sep 2024 16:59:51 +0200
Subject: [PATCH] docs: add a README

Signed-off-by: Raito Bezarius <masterancpp@gmail.com>
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4cb0e89
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# `wifisetup`
+
+An Android application to setup WPA2 Enterprise profiles automatically.
+
+## Nix
+
+### Build the application (failing for now):
+
+```console
+$ cd nix && nix-build -A builtWithGradle
+```
+
+### Update the locks
+
+```console
+$ cd nix && nix-build -A updateLocks
+$ cd ../android
+$ ../nix/result/bin/update-locks
+$ mv deps.json ../nix/
+```