From 98f1859a8e8fe9e2fd41369992a128bdd7b912dc Mon Sep 17 00:00:00 2001 From: Thomas Lambert <t.lambert@uliege.be> Date: Sun, 27 Nov 2022 02:00:16 +0100 Subject: [PATCH] doc: fix links, add download details --- CHANGELOG.md | 4 +--- README.md | 20 +++++++++++++++----- RELEASE.md | 5 +---- 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f65bade..c17aced 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,8 +9,6 @@ _This changelog will begin AFTER the first official public release of the code._ ## [Unreleased] -_Initial commit_: single rotor in hover/axial flows - ### Added ### Changed @@ -29,4 +27,4 @@ _Initial commit_: single rotor in hover/axial flows [keep_chglog]: <https://keepachangelog.com/en/1.0.0/> [Unreleased]: https://gitlab.uliege.be/thlamb/rotare/compare/0.0.0...main -[0.0.0]: https://gitlab.uliege.be/thlamb/rotare/releases/tag/0.0.0 +[0.0.0]: https://gitlab.uliege.be/thlamb/rotare/-/releases/0.0.0 diff --git a/README.md b/README.md index 995025e..b70e2b7 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ may not provide valid results in all situations. ### Download and install +### Using git + To download the latest working version of Rotare, simply run ```bash @@ -65,10 +67,18 @@ git clone --recursive https://gitlab.uliege.be/thlamb/rotare Keep it updated using `git pull --recurse-submodules`. -If you do not use `git`, the best way is to download the latest stable version -of Rotare from the [release page][rotare-releases]. _Note that simply -downloading the source code will likely not work as Rotare relies on separate -libraries; so please use the Release page._ +### Direct download + +If you do not use `git`, the best way to obtain a working version of rotare is +to download the latest stable version from the [release page][rotare-releases]. + +_Note_: Rotare uses dependencies which are not directly hosted in this +repository. Do not just downloading Rotare's repo this will not be enough! + +A special archive is available for each release in the the release page under +the name `COMPLETE CODE`. This archive contains all the dependencies needed for +the proper use of Rotare. Always download this one and not the automatically +generated _source code_ archives. ## Documentation @@ -129,5 +139,5 @@ The Rotare Software is provided under the [MIT license](LICENSE). [uliege-am]: https://www.am.uliege.be/ [rotare-doc]: https://gitlab.uliege.be/thlamb/rotare-doc/ [rotare-issues]: https://gitlab.uliege.be/thlamb/rotare/issues -[rotare-releases]: https://gitlab.uliege.be/thlamb/rotare/releases +[rotare-releases]: https://gitlab.uliege.be/thlamb/rotare/-/releases [aiaa-scitech]: https://www.aiaa.org/SciTech diff --git a/RELEASE.md b/RELEASE.md index 5a3660a..14e4ad9 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -6,7 +6,4 @@ and do not contain all dependencies. ## About this release -_Initial commit_. - -- Single rotor in hover/axial flows -- NOT YET VALIDATED +(Nothing yet) -- GitLab