Update README
Change-Id: Ia703fef39d87a1fb9ba2b3123a1378468206a618
Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/1105164
Reviewed-by: Ian McKellar <ianloic@google.com>
diff --git a/README.md b/README.md
index c3a03d7..0991f2b 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,9 @@
To run a local fidlbolt server:
1. Follow the [Fuchsia: Get Started][fuchsia] guide.
-2. Build FIDL tools: `fx build host_x64/{fidlc,fidlgen_{cpp,hlcpp,rust,go,dart}} zircon/tools`.
+2. Build FIDL tools: `fx build host_x64/{fidlc,fidlgen_{cpp,hlcpp,rust,go},fidl-{lint,format}}`.
3. Ensure that you have [Go][] and [Node.js][] installed.
-4. Build and run with `make run`.
+4. Build and run with `make && make run`.
5. View the app at `http://localhost:8080`.
If you don't want changes in the Fuchsia tree (e.g. rebuilding fidlc or changing FIDL libraries) to affect the running fidlbolt, run `./prepare_deployment.sh` and use `make run DEPLOYMENT=1` instead.
@@ -22,7 +22,7 @@
### Frontend
-The frontend is written in [Elm][] and [TypeScript][]. It uses [webpack][] for bundling.
+The frontend is written in [Elm][] and [TypeScript][]. It uses [esbuild][] for bundling.
To set up the frontend:
@@ -52,14 +52,22 @@
The project uses [Docker][] for containerized deployment.
-To build and run a new image locally:
+To build a new image:
1. Install [Docker][]. On Debian-based systems, use `sudo apt-get install docker-ce`.
2. `./prepare_deployment.sh`
-3. `docker image build -t fidlbolt .`
-4. `docker container run --publish 8080:8080 --detach --name fb fidlbolt`
+3. `sudo docker image build -t fidlbolt .`
-You might need to use `sudo` with the Docker commands.
+To run the image in a container locally:
+
+1. `sudo docker container run --publish 8080:8080 --detach --name fb fidlbolt`
+2. (When you're done) `sudo docker container rm fb`
+
+To push the image to the [GCP Artifact Registry][artifact-registry]:
+
+1. (Only the first time) `sudo gcloud auth configure-docker us-central1-docker.pkg.dev`
+2. `sudo docker tag fidlbolt us-central1-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE`
+3. `sudo docker push us-central1-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE`
[Docker]: https://www.docker.com/
[Elm]: https://elm-lang.org/
@@ -70,4 +78,5 @@
[fuchsia]: https://fuchsia.dev/fuchsia-src/getting_started
[godbolt]: https://godbolt.org/
[net/http]: https://golang.org/pkg/net/http/
-[webpack]: https://webpack.js.org/
+[esbuild]: https://esbuild.github.io/
+[artifact-registry]: https://cloud.google.com/artifact-registry/docs/docker/pushing-and-pulling
