diff --git a/README.md b/README.md index 4a41e0b9..ec13b91b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # SCTFE -This personality implements [CT Static API](https://c2sp.org/static-ct-api) using -Trillian Tessera to store data. It is based on [Trillian's CTFE](https://github.com/google/certificate-transparency-go/tree/master/trillian/ctfe). +This personality implements [CT Static API](https://c2sp.org/static-ct-api) +using [Trillian Tessera](https://github.com/transparency-dev/trillian-tessera) +to store data. It is based on +[Trillian's CTFE](https://github.com/google/certificate-transparency-go/tree/master/trillian/ctfe). It is under active development. @@ -21,6 +23,7 @@ To re-generate these files, first install the right tools: - [mockgen](https://github.com/golang/mock?tab=readme-ov-file#installation) Then, generate the files: + ```bash cd $(go list -f '{{ .Dir }}' github.com/transparency-dev/static-ct); \ go generate -x ./... # hunts for //go:generate comments and runs them diff --git a/deployment/live/gcp/test/README.md b/deployment/live/gcp/test/README.md index 4ac958eb..a19ede16 100644 --- a/deployment/live/gcp/test/README.md +++ b/deployment/live/gcp/test/README.md @@ -2,7 +2,9 @@ ## Prerequisites You'll need to have a VM running in the same GCP project that you can SSH to, -with Go installed, and your favourite terminal multiplexer. +with [Go](https://go.dev/doc/install) and +[terragrunt](https://terragrunt.gruntwork.io/docs/getting-started/install/) +installed, and your favourite terminal multiplexer. ## Overview @@ -19,11 +21,13 @@ At a high level, this environment consists of: First authenticate via `gcloud` as a principle with sufficient ACLs for the project: + ```bash gcloud auth application-default login ``` Set the required environment variables: + ```bash export GOOGLE_PROJECT={VALUE} export GOOGLE_REGION={VALUE} # e.g: us-central1