Update CONTRIBUTING.md

This commit is contained in:
Carl Tashian 2021-03-02 15:33:35 -08:00 committed by GitHub
parent b4d2368dfe
commit c67531134a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -19,7 +19,7 @@ to manage issues, etc.
Clone this repository to get a bleeding-edge build,
or download the source archive for [the latest stable release](https://github.com/smallstep/certificates/releases/latest).
### Building step-ca
### Build a standard `step-ca`
The only prerequisites are [`go`](https://golang.org/) and make.
@ -27,7 +27,9 @@ To build from source:
make bootstrap && make
### Building CGO step-ca (with PKCS#11 and YubiKey PIV support)
Find your binaries in `bin/`.
### Alternative: Build a CGO `step-ca` (with PKCS#11 and YubiKey PIV support)
To build the CGO version of `step-ca` you will need [`go`](https://golang.org/), make, gcc, pkg-config, and the [`libpcsclite-dev`](https://pcsclite.apdu.fr/) package. On Ubuntu:
@ -35,6 +37,8 @@ To build the CGO version of `step-ca` you will need [`go`](https://golang.org/),
sudo apt install -y make gcc libpcsclite-dev pkg-config
make bootstrap && make build GOFLAGS=""
Find your binaries in `bin/`.
## Asking Support Questions
Feel free to post a question on our [GitHub Discussions](https://github.com/smallstep/certificates/discussions) page, or find us on [Gitter](https://gitter.im/smallstep/community).