From 955906c411769aaa5c5a79c9215dd788b76d79c5 Mon Sep 17 00:00:00 2001
From: Markus Blatt <markus@dr-blatt.de>
Date: Mon, 10 Jan 2022 15:54:17 +0100
Subject: [PATCH] Improve README

Make it clear what is in the repository. Might help people
finding it via search engines.
---
 README.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 66f5b7b9c..7a0ed3ddd 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
-# opm-common
-Contains common components used throughout all of OPM,
-in particular CMake modules for the build system.
+# opm-common: Tools for Eclipse reservoir simulation files
+
+The Open Porous Media (OPM) software suite provides libraries and
+tools for modeling and simulation of porous media processes,
+especially  for simulating CO2 sequestration and improved and enhanced
+oil recovery. The Eclipse file format is widely used in the reservoir
+simulation  community. This package provides a library containing code
+for processing files in Eclipse format, Python binding for accessing
+Eclipse files and  utility code used by other OPM modules (e.g. CMake
+modules used).
+
+License
+-------
+
+The library is distributed under the GNU General Public License,
+version 3 or later (GPLv3+).
+
+Requirements
+-----------
+
+- C++17 compatible compiler
+- CMake >= 3.10