Add project description and development documentation
This commit is contained in:
parent
be7bbc8101
commit
0e32f7fd16
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue