Improve README
Make it clear what is in the repository. Might help people finding it via search engines.
This commit is contained in:
parent
aa77a9c6e9
commit
955906c411
25
README.md
25
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
|
||||
|
Loading…
Reference in New Issue
Block a user