From 95ed48d3e338a76f9060643b2b82b5339711a9c9 Mon Sep 17 00:00:00 2001
From: Christopher Cave-Ayland <c.cave-ayland@imperial.ac.uk>
Date: Wed, 13 Mar 2024 14:34:54 +0000
Subject: [PATCH] Update README with installation and development info

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index 5f427a2..c1ddd5f 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,27 @@ Welcome to your InvenioRDM instance.
 
 ## Getting started
 
+### Local Installation
+
+```console
+invenio-cli install
+invenio-cli services setup
+invenio-cli run
+```
+
+Once the Flask server has started visit https://127.0.0.1:5000 in your browser. Once
+finished, stop the running Flask server and use `invenio-cli services stop` to bring
+down the running services.
+
+Subsequently the server may be started with:
+
+```console
+invenio-cli services start
+invenio-cli run
+```
+
+### Docker
+
 Run the following commands in order to start your new InvenioRDM instance:
 
 ```console
@@ -21,6 +42,41 @@ Once running, visit https://127.0.0.1 in your browser.
 **Note**: The server is using a self-signed SSL certificate, so your browser
 will issue a warning that you will have to by-pass.
 
+## Development
+
+### QA
+It is strongly recommended to use [pre-commit] to check your individual commits meet the
+QA standards of the project. These are enforced via GitHub Actions and it's easiest to
+make sure you're compliant as you go along. Details of the QA tools can be found in
+`.pre-commit-config.yaml`.
+
+[pre-commit]: https://pre-commit.com/
+
+### Continuous Integration
+
+A simple Continuous Integration setup is provided via GitHub Actions. This checks the
+target commit against the project QA tooling and for commits to the main branch builds
+and pushes Docker images for the web application and frontend.
+
+### Local Installation
+
+The standard local installation as described in [Getting Started] is suitable for
+development.
+
+[Getting Started]: #getting-started
+
+### Docker
+
+A additional Docker Compose file is provided to give a simple development setup using
+Docker. Assuming Invenio services have aleady been setup, it can be used by:
+
+```console
+invenio-cli services start
+docker compose -f docker-compose.app-dev.yml up app
+```
+
+Then access https://127.0.0.1:5000 in the browser.
+
 ## Overview
 
 Following is an overview of the generated files and folders: