Refresh installation instructions #302
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The old flow of the page dates from the first open source release, when only bazel was fully supported, and we provided the single-file packaging as the "lowest common denominator" fallback that worked with everybody. This summer, we added official CMake support, and just last week, the community also added support for both conan and vcpkg. This radically changes and simplifies the recommended installation approach: now "full install" is the right choice for almost everyone! Accordingly, it's time to refresh our instructions. - Make up-front guidance simpler and more direct - Rearrange the table: put Full Install first; unify Full Install columns; clean up and explain some text - Remove decision flowchart: things are much simpler now, and we don't really need it - Refresh the bazel instructions to mention 0.3.5 (might as well) - Add links and instructions for installing with package managers - Move the single-file section _after_ the full install one I used "checkpoint commits" for this PR, so this last change is in a separate "pure-move" commit within the PR, to make this easier to review. The reviewer can also run `au-docs-serve` and do A/B comparison between two tabs: - https://aurora-opensource.github.io/au/main/install/ - http://127.0.0.1:8000/au/install/ Fixes #301.
chiphogg
added
the
release notes: 📝 documentation
geoffviola
approved these changes
Oct 21, 2024
|
|
||
| Each package manager contains setup instructions on its page for Au. Here are the packages: | ||
|
|
||
| - **Conan:** [au](https://conan.io/center/recipes/au) |
| Each package manager contains setup instructions on its page for Au. Here are the packages: | ||
|
|
||
| - **Conan:** [au](https://conan.io/center/recipes/au) | ||
| - **vcpkg:** [aurora-au](https://vcpkg.link/ports/aurora-au) |
| - A base dimensionless unit (`unos`) | ||
|
|
||
| !!! note | ||
| _How_ do you go about constructing other units from these? By **composing** them. For example, |
There was a problem hiding this comment.
Nit: I'm not sure why github doesn't like this character. It might want an escape character in front of it. The rendering looks fine.
There was a problem hiding this comment.
Yeah, I think github is just off base here in its syntax highlighting. I'm pretty confident the contents are just fine.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The old flow of the page dates from the first open source release, when
only bazel was fully supported, and we provided the single-file
packaging as the "lowest common denominator" fallback that worked with
everybody. This summer, we added official CMake support, and just last
week, the community also added support for both conan and vcpkg. This
radically changes and simplifies the recommended installation approach:
now "full install" is the right choice for almost everyone! Accordingly,
it's time to refresh our instructions.
columns; clean up and explain some text
really need it
I used "checkpoint commits" for this PR, so this last change is in a
separate "pure-move" commit within the PR, to make this easier to
review.
The reviewer can also run
au-docs-serveand do A/B comparison betweentwo tabs:
Fixes #301.