From 3f4711d518074568e4acb1db9c5df83ac6809a40 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Motiejus=20Jak=C5=A1tys?= <motiejus@jakstys.lt>
Date: Wed, 9 Feb 2022 13:14:42 +0200
Subject: [PATCH] [readme] add download/build instructions

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 0746737..686dfb7 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,29 @@ Turbo NSS
 
 glibc nss library for passwd and group.
 
+Checking out and building
+-------------------------
+
+```
+$ git clone --recursive https://git.sr.ht/~motiejus/turbonss
+```
+
+Alternatively, if you forgot `--recursive`:
+
+```
+$ git submodule update --init
+```
+
+And run tests:
+
+```
+$ zig build test
+```
+
+... the other commands will be documented as they are implemented.
+
+This project uses [git subtrac][git-subtrac] for managing dependencies.
+
 Steps
 -----
 
@@ -72,3 +95,5 @@ The following operations need to be fast, in order of importance:
 4. lookup groupname -> group.
 5. (optional) iterate users using a defined order (`getent passwd`).
 6. (optional) iterate groups using a defined order (`getent group`).
+
+[git-subtrac]: https://github.com/apenwarr/git-subtrac/