From 70281989893afcd9357d11b31437003d26f00179 Mon Sep 17 00:00:00 2001 From: Matthias Volk Date: Tue, 12 Nov 2019 14:18:11 +0100 Subject: [PATCH] Revised documentation --- README.md | 3 +++ doc/checklist_new_release.md | 18 +++++++++--------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7b7c33683..a8713c02c 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,17 @@ Storm has been developed at RWTH Aachen University. ###### Developers (lexicographical order) * Philipp Berger * David Korzeniewski +* Jip Spel ###### Contributors (lexicographical order) * Dimitri Bohlender +* Alexander Bork * Harold Bruintjes * Michael Deutschen * Thomas Heinemann * Thomas Henn * Tom Janson +* Jan Karuc * Gereon Kremer * Sascha Vincent Kurowski * Manuel Sascha Weiand diff --git a/doc/checklist_new_release.md b/doc/checklist_new_release.md index a55349ef5..e14f02667 100644 --- a/doc/checklist_new_release.md +++ b/doc/checklist_new_release.md @@ -1,7 +1,7 @@ The following steps should be performed before releasing a new storm version. Note that in most cases a simultaneous release of [carl](https://github.com/smtrat/carl), [storm](https://github.com/moves-rwth/storm), [pycarl](https://github.com/moves-rwth/pycarl/) and [stormpy](https://github.com/moves-rwth/stormpy/) is preferred. -1. Update `CHANGELOG.md` +1. Update `CHANGELOG.md`. To get all the commits from an author since the last tag execute: ```console git log last_tag..HEAD --author "author_name" @@ -11,14 +11,14 @@ Note that in most cases a simultaneous release of [carl](https://github.com/smtr * Update `GIT_TAG` in `resources/3rdparty/carl/CMakeLists.txt` * Maybe update `CARL_MINVERSION` in `resources/3rdparty/CMakeLists.txt` -3. Check that storm builds without errors and all tests are successful - * [Travis](https://travis-ci.org/moves-rwth/storm) should run successfully - * Invoke the script test_build_configurations.py to build and check different cmake configurations +3. Check that storm builds without errors and all tests are successful: + * [Travis](https://travis-ci.org/moves-rwth/storm) should run successfully. + * Invoke the script `doc/scripts/test_build_configurations.py` to build and check different CMake configurations. 4. Set new storm version: * Set new storm version in `version.cmake` -5. Set new tag in git +5. Set new tag in Git: ```console git tag -a new_version git push origin new_version @@ -28,10 +28,10 @@ Note that in most cases a simultaneous release of [carl](https://github.com/smtr git remote add github https://github.com/moves-rwth/storm.git git push github new_version ``` - The new tag should now be visible on [GitHub](https://github.com/moves-rwth/storm/tags) + The new tag should now be visible on [GitHub](https://github.com/moves-rwth/storm/tags). -6. [Add new release](https://github.com/moves-rwth/storm/releases/new) in GitHub +6. [Add new release](https://github.com/moves-rwth/storm/releases/new) in GitHub. -7. Update [Homebrew formula](https://github.com/moves-rwth/homebrew-storm) +7. Update [Homebrew formula](https://github.com/moves-rwth/homebrew-storm). -8. Announce new storm version on [website](http://www.stormchecker.org/news.html) +8. Announce new storm version on [website](http://www.stormchecker.org/news.html).