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.

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

docs: Add Conan installation in the documentation #1061

Merged
merged 2 commits into from
Aug 10, 2024

Conversation

uilianries
Copy link
Contributor

@uilianries uilianries commented Aug 5, 2024

Greetings, fellow CLI11 community!

We have just added the latest version of cli11 to Conan Center and thought it would be a nice addition to include instructions on how to install CLI11 via Conan in the book folder.

Please let me know if this is okay, or if you would prefer it placed elsewhere.

UPDATE: Some extra information to be more clear about the used command line and links:

I did not mention how to install/configure Conan, because both links to conan.io and conan-center-index has all Conan documentation updated. For instance: https://conan.io/downloads

The latest version of CLI11 available in Conan Center is 2.4.2:

or, can be found by running the conan command:

conan search "cli11"

The command conan install --requires="cli11/[*]" --build=missing means:

  • conan install: Install a package from a remote. By default, it points to the official Conan Center
  • --requires="cli11/[*]": Install the latest version of CLI11 available in Conan Center
  • --build=missing: In case not finding a pre-built package compatible, build it from source then.

Regards!

Copy link

codecov bot commented Aug 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e4ee3af) to head (6a1903a).
Report is 33 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main     #1061    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           17        17            
  Lines         4546      4583    +37     
  Branches         0       982   +982     
==========================================
+ Hits          4546      4583    +37     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@phlptp
Copy link
Collaborator

phlptp commented Aug 5, 2024

Looks good to me, but I have never used Conan, so can't speak much to it. I will give a couple days for @henryiii to take a look, then will merge if there are no objections.
Thanks

@uilianries
Copy link
Contributor Author

@phlptp Thank you for your quick response. Please, feel free to ask anything in case having doubts about using Conan.

@phlptp phlptp merged commit f4f225d into CLIUtils:main Aug 10, 2024
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants