From 0e32f7fd160029bd621b0ed121a8add636514883 Mon Sep 17 00:00:00 2001
From: Jan Dittberner <jandd@cacert.org>
Date: Tue, 29 Nov 2022 20:15:59 +0100
Subject: [PATCH] Add project description and development documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..10466b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# CAcert signer client
+
+This is the CAcert signer client implementation that sends commands to the signer and handles certificate
+revocation lists (CRLs), OpenPGP public key signatures and X.509 certificates.
+
+## Development preconditions
+
+You will need GNU make to build the application. On Debian systems you can install GNU make using:
+
+```shell
+sudo apt install make
+```
+
+Install [go](https://go.dev/) >= 1.17, [golangci-lint](https://golangci-lint.run/usage/install/) >= 1.50.0 and
+[goreleaser](https://goreleaser.com/install/), as these are used for building and linting the application.
+
+Read the documentation of these tools, to find out how to use them.
+
+## Building the binary
+
+There is a `Makefile` to build the signerclient binary. Run
+
+```shell
+make
+```
+
+to run linting, tests and binary builds.