docs: Document working locally + Conan 2.0 commands #13102
Conversation
I also snuck in some format and link fixes
|
Don't hesitate to leave feedback! If you have a better way please let me know ❤️ |
|
|
||
| ### Try it yourself | ||
|
|
||
| For instance you can create packages for `fmt` in various supported configurations by running: |
There was a problem hiding this comment.
I'd like to purpose fmt as the standard example... its quick to build and has all the configuration supported by CCI and no deps so it should always work 🤞
|
|
||
| ```sh | ||
| cd recipes/fmt | ||
| conan create all/conanfile.py --version 9.0.0 |
There was a problem hiding this comment.
Is not dual profile mandatory for Conan 2.0?
There was a problem hiding this comment.
It's the defaults that changed. But you do not need to manually specify it
the defaults match what the 1.x docs are showing
|
|
||
| Getting started is easy. Try building an existing package with our [developing recipes](../developing_recipes_locally.md) tutorial. | ||
| To deepen you understanding, start with the [How to provide a good recipe](#how-to-provide-a-good-recipe) section. | ||
| You can follow the three steps (:one: :two: :three:) described below! :tada: |
There was a problem hiding this comment.
Should not be 1, 2, 3 links to sections in this doc?
There was a problem hiding this comment.
Brilliant idea! sadly this one does not break like that but
🤞 should be able to fix that soon
Co-authored-by: Uilian Ries <uilianries@gmail.com>
|
|
||
| ### Try it yourself | ||
|
|
||
| For instance you can create packages for `fmt` in various supported configurations by running: |
docs/developing_recipes_locally.md
Outdated
| export PYTHONPATH=your/path/conan-center-index | ||
| ``` | ||
|
|
||
| * Now you just need to execute the `pylint` commands: |
There was a problem hiding this comment.
It might be nice to leverage something like pre-commit to make it easy to have the linters run before committing code locally. I'm liable to forget.
There was a problem hiding this comment.
Me too 🙊 one day we will have an easier way than in the PR
There was a problem hiding this comment.
You can add a new hook which run linter on pre-export.
There was a problem hiding this comment.
👏
We should add the spdx hook too
Co-authored-by: Jordan Williams <jordan@jwillikers.com>
|
👋 @ericLemanissier @SpaceIm @toge @Croydon Looking for some reviews pretty please ❤️ |
docs/developing_recipes_locally.md
Outdated
| export PYTHONPATH=your/path/conan-center-index | ||
| ``` | ||
|
|
||
| * Now you just need to execute the `pylint` commands: |
There was a problem hiding this comment.
You can add a new hook which run linter on pre-export.
Co-authored-by: Uilian Ries <uilianries@gmail.com>
|
Should be good for a last review 🤞 |
Co-authored-by: Jordan Williams <jordan@jwillikers.com>
|
@jwillikers thank you soo much!!!!! it shows we are not native english speakers and/or wrote too much docs ❤️ really appreciate the great review |
|
Why is this not being merged 🤔 |
* docs: Document working locally + Conan 2.0 commands I also snuck in some format and link fixes * Apply suggestions from code review Co-authored-by: Uilian Ries <uilianries@gmail.com> * Update docs/README.md * Update docs/developing_recipes_locally.md * Apply suggestions from code review Co-authored-by: Jordan Williams <jordan@jwillikers.com> * Update CONTRIBUTING.md Co-authored-by: Uilian Ries <uilianries@gmail.com> * merge linters into dev locally * links and touch ups * fix links * Apply suggestions from code review Co-authored-by: Jordan Williams <jordan@jwillikers.com> Co-authored-by: Uilian Ries <uilianries@gmail.com> Co-authored-by: Jordan Williams <jordan@jwillikers.com>
Docs!
🌟 Goal
I also snuck in