From f2323ecebe53193a81279b50b53d7f59d3f55add Mon Sep 17 00:00:00 2001 From: Thomas Lambert <t.lambert@uliege.be> Date: Wed, 1 Feb 2023 22:19:45 +0100 Subject: [PATCH] doc(readme): fix license, add note about versions --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5ef380e..2e16bd5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ This repository contains the complete documentation related to [**Rotare**][rotare-repo], a feature-rich and open-source implementation of the Blade Element Momentum Theory in MATLAB. +## IMPORTANT NOTE +**Rotare is still currently in development. As long as it is not in v1.0.0, the +documentation may not accurately represent the state of the code.** + +Once v1.0.0 will be released, the documentation will be updated periodically to +reflect the changes in the main version of Rotare. + ## Documentation The documentation is separated in two distinct parts. @@ -23,21 +30,15 @@ description of the solvers implemented and of the models used to extend and correct the base methodology. This technical part also comes with the presentation of many validation cases. -## Other - -An abstract was submitted for the presentation of Rotare during the [AIAA -SciTech 2023 forum][aiaa-scitech] at National Harbor, MD (USA). It is currently -in review by the conference committee. - ## License The present documentation is provided under the [CC-BY-SA-4.0] license. Please -refer to the [Notice](Notice) for the licensing information of the different +refer to the [Notice](NOTICE.md) for the licensing information of the different packages present in this repository. -The Rotare Software is provided under the [Apache-2.0] license. +The Rotare Software is provided under the [MIT license]. [aiaa-scitech]: https://www.aiaa.org/SciTech [rotare-repo]: https://gitlab.uliege.be/thlamb/rotare -[Apache-2.0]: licenses/Apache-2.0.md +[MIT]: https://gitlab.uliege.be/thlamb/rotare/-/blob/main/LICENSE [CC-BY-SA-4.0]: https://creativecommons.org/licenses/by-sa/4.0/ -- GitLab