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 updates #2536

Merged
merged 18 commits into from Feb 23, 2023
Merged

README updates #2536

merged 18 commits into from Feb 23, 2023

Conversation

kgodey
Copy link
Contributor

@kgodey kgodey commented Feb 21, 2023

Fixes #2495. The intent is to make our README a good starting point for people discovering our project.

Please see:

Please note:

  • Local development setup link in the new README will not work until this PR is merged to master.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the master branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@kgodey kgodey self-assigned this Feb 21, 2023
@kgodey kgodey added this to the 2023-02 Launch Blockers milestone Feb 21, 2023
@kgodey kgodey marked this pull request as ready for review February 22, 2023 22:27
@kgodey kgodey added ready Ready for implementation pr-status: review A PR awaiting review and removed status: draft labels Feb 22, 2023
@kgodey kgodey removed the ready Ready for implementation label Feb 22, 2023
@kgodey kgodey removed their assignment Feb 22, 2023
Copy link
Contributor

@seancolsen seancolsen left a comment

Choose a reason for hiding this comment

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

Looks good @kgodey. I added 534f0ad which gives a small amount of space between each screenshot so they don't blend together.

@seancolsen seancolsen added this pull request to the merge queue Feb 23, 2023
Merged via the queue into master with commit 5a29286 Feb 23, 2023
@seancolsen seancolsen deleted the update_readme branch February 23, 2023 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Update README to be more comprehensive
2 participants