From 05577c2bbe51af4d60524f36ccc219dbe5981540 Mon Sep 17 00:00:00 2001 From: Matteo Nastasi Date: Fri, 14 Oct 2016 11:18:35 +0200 Subject: [PATCH] Update links in README for engine-2.1 release --- README.md | 54 +++++++++++++++++++++++++++++------------------------- 1 file changed, 29 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index ea01b3638148..ced0ad0855d1 100644 --- a/README.md +++ b/README.md @@ -8,57 +8,61 @@ Jenkins (Python 2): [![Build Status](https://ci.openquake.org/job/master_oq-engi Travis CI (Python 3): [![Build Status](https://travis-ci.org/gem/oq-engine.svg?branch=master)](https://travis-ci.org/gem/oq-engine) -### Current stable +## OpenQuake Engine version 2.1 (Benioff) -Current stable version is the **OpenQuake Engine 2.1** 'Benioff'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-2.1#openquake-engine. +Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists. -## Documentation (master tree) +The code name for version 2.1 is **Benioff**, in memory of [Hugo Benioff](https://en.wikipedia.org/wiki/Hugo_Benioff). + +## Documentation + +* [What's new](https://github.com/gem/oq-engine/blob/engine-2.1/doc/whats-new.md) ### General overview -* [About](https://github.com/gem/oq-engine/blob/master/doc/about.md) -* [FAQ](https://github.com/gem/oq-engine/blob/master/doc/faq.md) +* [About](https://github.com/gem/oq-engine/blob/engine-2.1/doc/about.md) +* [FAQ](https://github.com/gem/oq-engine/blob/engine-2.1/doc/faq.md) * [Manuals](http://www.globalquakemodel.org/openquake/support/documentation/engine/#manual-latest-stable) * [Source Code/API Documentation](http://docs.openquake.org/oq-engine/) -* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/master/doc/development-guidelines.md) -* [Developers Notes](https://github.com/gem/oq-engine/blob/master/doc/development-notes.md) -* [Architecture](https://github.com/gem/oq-engine/blob/master/doc/architecture.md) -* [Calculation Workflow](https://github.com/gem/oq-engine/blob/master/doc/calculation-workflow.md) -* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/master/doc/hardware-suggestions.md) -* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/master/doc/testing.md) -* [Glossary of Terms](https://github.com/gem/oq-engine/blob/master/doc/glossary.md) +* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/engine-2.1/doc/development-guidelines.md) +* [Developers Notes](https://github.com/gem/oq-engine/blob/engine-2.1/doc/development-notes.md) +* [Architecture](https://github.com/gem/oq-engine/blob/engine-2.1/doc/architecture.md) +* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-2.1/doc/calculation-workflow.md) +* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-2.1/doc/hardware-suggestions.md) +* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-2.1/doc/testing.md) +* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-2.1/doc/glossary.md) ### Installation -* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/master/doc/requirements.md) -* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/master/doc/installing/overview.md) +* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/engine-2.1/doc/requirements.md) +* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/overview.md) #### Linux -* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/master/doc/installing/ubuntu.md) -* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/master/doc/installing/rhel.md) -* [Installing on other flavors](https://github.com/gem/oq-engine/blob/master/doc/installing/linux-generic.md) -* [Installing from sources](https://github.com/gem/oq-engine/blob/master/doc/installing/development.md) -* [Installing on a cluster](https://github.com/gem/oq-engine/blob/master/doc/installing/cluster.md) +* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/ubuntu.md) +* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/rhel.md) +* [Installing on other flavors](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/linux-generic.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/development.md) +* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/cluster.md) #### macOS -* [Installing on macOS](https://github.com/gem/oq-engine/blob/master/doc/installing/macos.md) +* [Installing on macOS](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/macos.md) #### Windows -* [Installing on Windows](https://github.com/gem/oq-engine/blob/master/doc/installing/windows.md) -* [Starting the software](https://github.com/gem/oq-engine/blob/master/doc/running/windows.md) +* [Installing on Windows](https://github.com/gem/oq-engine/blob/engine-2.1/doc/installing/windows.md) +* [Starting the software](https://github.com/gem/oq-engine/blob/engine-2.1/doc/running/windows.md) ### Running the OpenQuake Engine -* [Using the command line](https://github.com/gem/oq-engine/blob/master/doc/running/unix.md) -* [Using the WebUI](https://github.com/gem/oq-engine/blob/master/doc/running/server.md) +* [Using the command line](https://github.com/gem/oq-engine/blob/engine-2.1/doc/running/unix.md) +* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-2.1/doc/running/server.md) ## License -The OpenQuake Engine is released under the **[GNU Affero Public License 3](https://github.com/gem/oq-engine/blob/master/LICENSE)**. +The OpenQuake Engine is released under the **[GNU Affero Public License 3](https://github.com/gem/oq-engine/blob/engine-2.1/LICENSE)**. ## Contacts