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.

Sign up for GitHub

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

Jump to bottom

revamp README #70

Merged
merged 3 commits into from
Mar 3, 2023
Merged

revamp README #70

merged 3 commits into from
Mar 3, 2023

Conversation

zeke
Copy link
Member

@zeke zeke commented Feb 20, 2023

This PR updates the README:

  • Puts content in the chronological order that integrators need it: Installation, environment setup, usage...
  • Adds headings so we can deep link to specific parts of the README
  • Replaces the resnet image input example with something more relevant

@zeke zeke requested review from erbridge and mattt February 20, 2023 21:25
@zeke
revamp README
524af94 
Signed-off-by: Zeke Sikelianos <zeke@sikelianos.com>
@zeke zeke mentioned this pull request Feb 20, 2023
Closed
erbridge
erbridge approved these changes Feb 22, 2023
View reviewed changes
Copy link
Member

@erbridge erbridge left a comment

Choose a reason for hiding this comment

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

Looks great. Couple of minor edits.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
zeke and others added 2 commits March 3, 2023 09:12
@zeke @erbridge
Update README.md
1769ba9 
Co-authored-by: F <f@erbridge.co.uk>
@zeke @erbridge
Update README.md
2344be4 
Co-authored-by: F <f@erbridge.co.uk>
@zeke zeke merged commit 5e0f6b7 into main Mar 3, 2023
@zeke zeke deleted the revamp-readme branch March 3, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erbridge erbridge erbridge approved these changes

@mattt mattt Awaiting requested review from mattt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zeke @erbridge