Add README.md and licensesHEADmain

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..49fd5d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Docker image for the DFTCalc tool with the Storm backend
+
+This Docker image combines the [DFTCalc](https://fmt.ewi.utwente.nl/tools/dftcalc/) tool for calculating the failure probability of a Dynamic Fault Tree with the [Storm](https://www.stormchecker.org/) Probabilistic Model Checker backend and the [DFTRES](https://github.com/utwente-fmt/DFTRES) rare event simulator.
+
+To make the analysis return floating point results, DFTCalc was patched. Currently, this makes the `--exact` command-line option unuseable, but floating point analysis should be fine. For more information, see [utwente-fmt/dftcalc#14](https://github.com/utwente-fmt/dftcalc/issues/14).
+
+The image is available in the [docker.io/ftsrg/clevr](https://hub.docker.com/r/ftsrg/clevr/) repository as the tag `ftsrg/clevr:dftcalc-storm`. However, to get the lates version of the software, it is recommended to build the image yourself.
+
+## License
+
+The Docker image is a mere aggregation of software available under their respective licenses. In particular,
+
+* [DFTCalc](https://fmt.ewi.utwente.nl/tools/dftcalc/) is available under the [MIT License](https://en.wikipedia.org/wiki/MIT_License). For more information, see the file `LICENSE.MIT.DFTCalc`. Note that while the [DFTCalc home page](https://web.archive.org/web/20190523201308/https://fmt.ewi.utwente.nl/tools/dftcalc/) indicated that the license is MIT, such indication is missing from the source repository as of 2021-03-25.
+* Portions of the DFTCalc source repository contain code from the work [BCGConv](https://github.com/utwente-fmt/dftcalc/tree/529c7fb1410fb2c68d79b61d4e131adece6c2e77/bcgconv), which is available under the [GNU General Public License, Version 3 or later](https://www.gnu.org/licenses/gpl-3.0.en.html). For more information, see the file `LICENSE.GPL-3.0.BCGConv`.
+* [Storm](https://www.stormchecker.org/) is available under the [GNU General Public License, Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). For more information, see the file `LICENSE.GPL-3.0.Storm`.
+* [DFTRES](https://github.com/utwente-fmt/DFTRES) is available under the [GNU General Public License, Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). For more information, see the file `LICENSE.GPL-3.0.DFTRES`.
+
+The `Dockerfile`, the patch `storm-non-exact.pacth`, as well this document are _unlicensed_:
+
+> This is free and unencumbered software released into the public domain.
+> 
+> Anyone is free to copy, modify, publish, use, compile, sell, or
+> distribute this software, either in source code form or as a compiled
+> binary, for any purpose, commercial or non-commercial, and by any
+> means.
+> 
+> In jurisdictions that recognize copyright laws, the author or authors
+> of this software dedicate any and all copyright interest in the
+> software to the public domain. We make this dedication for the benefit
+> of the public at large and to the detriment of our heirs and
+> successors. We intend this dedication to be an overt act of
+> relinquishment in perpetuity of all present and future rights to this
+> software under copyright law.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+> IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+> OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+> ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+> OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to the file `UNLICENSE` or [http://unlicense.org/](http://unlicense.org).