diff --git a/README.adoc b/README.adoc index c1db1da7..f046d76f 100644 --- a/README.adoc +++ b/README.adoc @@ -6,21 +6,25 @@ :icons: font :license: MIT -==== -image::https://github.com/fnf-org/TicketBooth/actions/workflows/rspec.yml/badge.svg[TicketBooth CI: RSpec,link=https://github.com/fnf-org/TicketBooth/actions/workflows/rspec.yml] +[cols=">h,>h", width="50%"] +|=== +| Test & Lint Status | Build & Packaging Status +|https://github.com/fnf-org/TicketBooth/actions/workflows/rspec.yml[image:https://github.com/fnf-org/TicketBooth/actions/workflows/rspec.yml/badge.svg[TicketBooth CI: RSpec]] -image::https://github.com/fnf-org/TicketBooth/actions/workflows/lint.yml/badge.svg[TicketBooth CI: RuboCop,link=https://github.com/fnf-org/TicketBooth/actions/workflows/lint.yml] +https://github.com/fnf-org/TicketBooth/actions/workflows/lint.yml[image:https://github.com/fnf-org/TicketBooth/actions/workflows/lint.yml/badge.svg[TicketBooth CI: RuboCop]] -https://github.com/fnf-org/TicketBooth/actions/workflows/deploy.yml[image:https://github.com/fnf-org/TicketBooth/actions/workflows/deploy.yml/badge.svg[DeployToGKE]] +| https://github.com/fnf-org/TicketBooth/actions/workflows/deploy.yml[image:https://github.com/fnf-org/TicketBooth/actions/workflows/deploy.yml/badge.svg[Deploy to Google Cloud]] -https://github.com/fnf-org/TicketBooth/actions/workflows/build.yml[image:https://github.com/fnf-org/TicketBooth/actions/workflows/build.yml/badge.svg[Create -and publish a Docker image]] +https://github.com/fnf-org/TicketBooth/actions/workflows/build.yml[image:https://github.com/fnf-org/TicketBooth/actions/workflows/build.yml/badge.svg[Publish Docker Image]] +|=== ==== - NOTE: Please see the https://github.com/fnf-org/TicketBooth/blob/main/README.pdf[README.pdf] for the PDF version of this README. +--- + NOTE: Please see the xref:#acknowledgements[Acknowledgements] at the end of this page. +==== == Welcome to the *Ticket Booth*! @@ -61,7 +65,7 @@ This should install all of the Brew dependencies, start PostgreSQL, memcached, a [source,bash] make dev -This actually starts Foreman via `bundle exec foreman -f Procfile.dev` — this is required to start CSS and JS just-in-time compilcation in addition to the Rails server. +This actually starts Foreman via `bundle exec foreman -f Procfile.dev` — this is required to start CSS and JS just-in-time compilcation in addition to the Rails server. The server will run on port 8080, and in development will hot swap any locally modified files, including CSS and JS. diff --git a/README.pdf b/README.pdf index fb7ed77e..408060f1 100644 Binary files a/README.pdf and b/README.pdf differ