search

colcon / colcon-cargo

An extension for colcon-core to support Rust projects built with Cargo
http://colcon.readthedocs.io
Apache License 2.0
30 stars 20 forks source link

docs: Initial commit to add basic set up tutorial to README.md #16

Closed jaron-l closed 3 years ago

jaron-l commented 3 years ago

Saw this as low hanging fruit in order to get involved. Trying to address #12 by adding some basic documentation of how to get this extension working.

esteve commented 3 years ago

@jaron-l thanks for your PR, however I'm not sure about the goal of #12 , @bergercookie can you clarify what your request is? The README file for other colcon extension are equally sparse as colcon-cargo's (see https://github.com/colcon/colcon-bazel#readme https://github.com/colcon/colcon-powershell#readme )

jaron-l commented 3 years ago

I see that other repositories don't have any documentation but I would think that any documentation is better than no documentation.

I would agree that coming to a consensus on what #12 is referencing would be a great idea.

bergercookie commented 3 years ago

Took me a while to answer ^^ The issue I had raised was mainly about adding to the README and demonstrating a way colcon-cargo, what sort of input or file structure it expected and what's the expected results.

To that end, I think @jaron-l 's PR looks good! I'll leave a few comments to this but overall LGTM

bergercookie commented 3 years ago

@jaron-l I've tweaked the README a bit. let me know if you're still happy with it!

esteve commented 3 years ago

@bergercookie I've assigned you as a reviewer, if you think the changes are fine and match what you wanted for #12, feel free to merge this approve this PR and merge it. Thanks!

jaron-l commented 3 years ago

@jaron-l I've tweaked the README a bit. let me know if you're still happy with it!

Looks good to me

bergercookie commented 3 years ago

Merged, thanks!