Skip to content
Snippets Groups Projects
Verified Commit f2323ece authored by Thomas Lambert's avatar Thomas Lambert :helicopter:
Browse files

doc(readme): fix license, add note about versions

parent fa8855c9
No related branches found
No related tags found
No related merge requests found
Pipeline #11414 failed
...@@ -4,6 +4,13 @@ This repository contains the complete documentation related to ...@@ -4,6 +4,13 @@ This repository contains the complete documentation related to
[**Rotare**][rotare-repo], a feature-rich and open-source implementation of the [**Rotare**][rotare-repo], a feature-rich and open-source implementation of the
Blade Element Momentum Theory in MATLAB. 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 ## Documentation
The documentation is separated in two distinct parts. 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 ...@@ -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 correct the base methodology. This technical part also comes with the
presentation of many validation cases. 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 ## License
The present documentation is provided under the [CC-BY-SA-4.0] license. Please 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. 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 [aiaa-scitech]: https://www.aiaa.org/SciTech
[rotare-repo]: https://gitlab.uliege.be/thlamb/rotare [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/ [CC-BY-SA-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment