From be83b22993ac317a912f66063fcdd8e6f599ed3d Mon Sep 17 00:00:00 2001
From: Ralph Lange <ralph.lange@gmx.de>
Date: Mon, 27 May 2019 13:12:15 +0200
Subject: [PATCH] Readme: better and more detailed Travis instructions

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 39 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8ba4222..8e9ec60 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
-# ci-scripts
-Scripts for Continuous Integration setups
+# Continuous Integration Scripts for EPICS Modules
+
+The scripts in this repository are intended to provide a common,
+easy-to-use and flexible way to add Continuous Integration to EPICS
+software modules, e.g. Device Support modules.
+
+By including this repository as a Git Submodule, your module will
+always use an explicit commit, i.e. a fixed version of the scripts.
+That way, further development of these scripts cannot break
+your setup.
+
+## Travis-CI
+
+### Features
+
+ -  Compile against different version of EPICS Base
+ -  Use different versions of compilers (gcc, clang)
+ -  Cross-compile for Windows 32bit using MinGW and WINE
+ -  Cross-compile for RTEMS 4.9 and 4.10
+ -  Compile on MacOS
+ 
+### How to Use these Scripts
+
+ 1. In your Support Module, add this respository as a Git Submodule
+    (name suggestion: `.ci`).
+	```
+	$ git submodule add https://github.com/epics-base/ci-scripts .ci
+    ```
+	
+ 2. Create a Travis configuration by copying one of the examples.
+    ```
+    $ cp .ci/.travis.yml.example-full .travis.yml
+	```
+	
+ 3. Edit the `.travis.yml` configuration to include the jobs you want
+    Travis to run.
+	
+ 4. Push your changes and check 
+    [travis-ci.org](https://travis-ci.org/) for your build results.