Fix readme file not populating on the correct docs versions #711
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently, ue4ss home page and release tag (i.e. v3.0.1) shows the instructions for building ue4ss against main branch, which is incorrect, and has lead to a lot of confusion where people are trying to build C++ mods against main branch, while having stable version of ue4ss installed, which don't work. This is especially bad current as the build system is different between v3.0.1 and dev version.
Adds proper caution tags to the top of the readme depending on the version being viewed
Also edit readmes for non-dev versions that reflects the correct way to clone the repository
How Has This Been Tested?
cargo binstall --no-confirm mdbook-mermaid
mdbook-mermaid install docs-export/
cargo binstall --no-confirm mdbook-alerts
python docs-export/export.py
python docs-repo/build.py
docs-repo/docs/
and then open index.html and view readmeRelease readme changes:
Dev readme:
No change to the build instructions
Any release tag version (e.g. v3.0.0):