Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document vcpkg install #301

Closed
andre-nguyen opened this issue Oct 16, 2024 · 1 comment · Fixed by #302
Closed

Document vcpkg install #301

andre-nguyen opened this issue Oct 16, 2024 · 1 comment · Fixed by #302
Labels
⬇️ affects: documentation Improvements or additions to documentation 📁 kind: cleanup Making the library nicer in some way, without affecting functionality much or at all 💪 effort: small

Comments

@andre-nguyen
Copy link

Hey @chiphogg

Guess we can change the line below now that this got merged 🥳 microsoft/vcpkg#41119

au/docs/install.md

Line 51 in fb03848

<td class="poor">Not <i>yet</i> supported<br>(use <b>single-file</b> instead for now)</td>

I don't mind writing it in but I wonder what you would put in the decision diagram?
@chiphogg
Copy link
Contributor

Very exciting! And by what appears to be a huge coincidence, it landed on the exact same day as conan support (conan-io/conan-center-index#25447). 😮

I should probably give the whole installation page a once-over. I think I can get to that by this weekend.

@chiphogg chiphogg added ⬇️ affects: documentation Improvements or additions to documentation 📁 kind: cleanup Making the library nicer in some way, without affecting functionality much or at all 💪 effort: small labels Oct 17, 2024
chiphogg added a commit that referenced this issue Oct 20, 2024
@chiphogg
Refresh installation instructions
cd1efb4 
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 chiphogg mentioned this issue Oct 20, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
⬇️ affects: documentation Improvements or additions to documentation 📁 kind: cleanup Making the library nicer in some way, without affecting functionality much or at all 💪 effort: small
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refresh installation instructions aurora-opensource/au
2 participants
@chiphogg @andre-nguyen