Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Add a Quick Start guide and make options more consistent #10

Merged
merged 3 commits into from
May 15, 2024
Merged

Add a Quick Start guide and make options more consistent #10

merged 3 commits into from
May 15, 2024

Conversation

llucax
Copy link
Contributor

@llucax llucax commented May 15, 2024

  • Rename out_dir to out_path`
  • Fix reference to the added command
  • Add a Quick Start section to the README

llucax added 3 commits May 15, 2024 14:43
@llucax
Rename out_dir to out_path`
f18ae3b 
This is just to be more consistent with the `proto_path` option.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Fix reference to the added command
2b72df6 
This was using an old name.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Add a Quick Start section to the README
23ec430 
Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax requested a review from a team as a code owner May 15, 2024 12:47
@llucax llucax requested a review from shsms May 15, 2024 12:47
@llucax llucax self-assigned this May 15, 2024
@llucax llucax added this to the v0.1.0 milestone May 15, 2024
@github-actions github-actions bot added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:codegen Affects the protobuf code generation labels May 15, 2024
@llucax llucax requested a review from Marenz May 15, 2024 12:47
@llucax llucax added cmd:skip-release-notes It is not necessary to update release notes for this PR type:enhancement New feature or enhancement visitble to users labels May 15, 2024
@llucax llucax enabled auto-merge May 15, 2024 12:49
@llucax llucax disabled auto-merge May 15, 2024 12:49
@llucax
Copy link
Contributor Author

llucax commented May 15, 2024

Force merging as they are minor things and I want to get v0.1.0 out.

@llucax llucax merged commit 9cb2be8 into frequenz-floss:v0.x.x May 15, 2024
15 of 16 checks passed
@llucax llucax deleted the improvements branch May 15, 2024 12:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shsms shsms Awaiting requested review from shsms shsms is a code owner automatically assigned from frequenz-floss/python-sdk-team

@Marenz Marenz Awaiting requested review from Marenz

Assignees

@llucax llucax

Labels
cmd:skip-release-notes It is not necessary to update release notes for this PR part:codegen Affects the protobuf code generation part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests type:enhancement New feature or enhancement visitble to users
Projects
None yet
Milestone
v0.1.0
Development

Successfully merging this pull request may close these issues.
1 participant
@llucax