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

readme: add reference to packages dir #2001

Merged
merged 4 commits into from
Feb 8, 2023
Merged

Conversation

aciba90
Copy link
Contributor

@aciba90 aciba90 commented Feb 7, 2023

Proposed Commit Message

readme: add reference to packages dir

Additional Context

LP: #2006065

@holmanb
Copy link
Member

holmanb commented Feb 7, 2023

I think that Håvard is getting at something important. Most projects have a Build, Test, Install section, which also doubles as a starting point for anyone trying to use the project. Since our Build/Install isn't really independent of OS/Distro packaging and implementation details, we should probably add something to the packaging page explaining this (and that most users want a pre-built image) - it is a bit unique for a project. This is due to the code being tightly coupled to OS implementation, but the typical user might not realize this.

Also, I didn't realize this packages readme existed. I have a list of links to some other downstream resources that I'll include a PR to shortly.

@holmanb holmanb self-assigned this Feb 7, 2023
@aciba90
Copy link
Contributor Author

aciba90 commented Feb 8, 2023

@holmanb, thanks for pointing out that. I have added documentation about it.

Copy link
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have one small wording change request. Otherwise it looks good to me.

packages/README.md Outdated Show resolved Hide resolved
Co-authored-by: Brett Holman <bpholman5@gmail.com>
packages/README.md Outdated Show resolved Hide resolved
@holmanb holmanb merged commit aba65bf into canonical:main Feb 8, 2023
@aciba90 aciba90 deleted the build-doc branch February 8, 2023 17:30
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