From 35adf6f26d94d48a75baaf652172dc1cefc0f7ff Mon Sep 17 00:00:00 2001
From: Gustavo de Souza dos Reis <gustavo.reis@lnls.br>
Date: Wed, 28 Aug 2024 15:26:44 -0300
Subject: [PATCH] Add README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..253de1c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# EPICS IOC for uTCA crate management
+
+[![Continuous Integration
+Status](https://github.com/lnls-dig/ipmi-mgr-epics-ioc/actions/workflows/build.yml/badge.svg)](https://github.com/lnls-dig/ipmi-mgr-epics-ioc/actions)
+
+This repository contains the EPICS Input/Output Controller (IOC) used at LNLS
+for managing uTCA crates, based on
+[ipmiComm](https://github.com/slac-epics-modules/ipmiComm) support module.
+
+## Running the IOC
+
+You can use the following command to run it in the background using the default
+start-up script from
+[epics-in-docker](https://github.com/cnpem/epics-in-docker). First, define the
+variables `IPADDR` with the MCH Hostname and `AREA` with its location e.g.
+`IPADDR=IA-01RaBPM-Co-CrateCtrl AREA=IA-01RaBPM`
+
+```bash
+IPADDR={MCH_HOSTNAME} AREA={MCH_LOCATION} docker compose up -d
+```
+
+## Building the IOC image
+
+You can build the IOC with the following command:
+
+```bash
+TAG=latest docker compose build
+```