diff --git a/README b/README deleted file mode 100644 index 0b3ce7630..000000000 --- a/README +++ /dev/null @@ -1,24 +0,0 @@ - -Magics++ README -=============== - -1. Getting the source -===================== - -The tarball of the source can be downloaded from - - https://software.ecmwf.int/magics/Releases - - -2. Installation -=============== - -Please read the installation guide: - - https://software.ecmwf.int/magics/Installation+Guide - - -3. License -========== - -Please read COPYING and LICENSE. diff --git a/README.md b/README.md index d96ec775d..cddb14f73 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ -Magics -====== -Magics is the latest generation of the ECMWF's meteorological plotting software and can be either accessed directly through its Python. -Project home: https://software.ecmwf.int/magics +Magics++ README +=============== -To learn how to use it, have a look at our [notebook examples](https://github.com/ecmwf/notebook-examples/tree/master/visualisation) +[![Windows: master](https://img.shields.io/appveyor/ci/ecmwf/magics/master.svg?label=windows-master)](https://ci.appveyor.com/project/ecmwf/magics/branch/master) +[![Windows: develop](https://img.shields.io/appveyor/ci/ecmwf/magics/develop.svg?label=windows-dev)](https://ci.appveyor.com/project/ecmwf/magics/branch/develop) -Requirements +Getting the source +------------------ + +The tarball of the source can be downloaded from + + https://software.ecmwf.int/magics/Releases + + +Installation ------------ -- ecBuild (Magics can not be build without it) +Please read the installation guide: + + https://software.ecmwf.int/magics/Installation+Guide + + +License +---------- + +Please read COPYING and LICENSE.