One or more paragraphs describing the app: what it’s used for and how it relates to the rest of GOV.UK. Try to link to existing documentation and other READMEs to help keep the description concise.
Live examples
(Only applies to frontend apps.)
A list of links to example pages rendered by the app.
Nomenclature
A list of definitions for unusual terms in the code.
Technical documentation
What goes here depends on the type of app.
See the links below for example content to put here.
Before running the app (if applicable)
Anything that’s not done automatically by the development environment:
Dependencies that need to be installed manually.
One-off commands that need to be run manually.
Running the test suite
The default rake task runs all the tests:
govuk-docker run publisher-lite bundle exec rake
Further documentation
A list of links to key files in docs/.
You can also just link to the docs/ directory itself.