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

Improve the Readme of the repository #480

Closed
slemeur opened this issue Mar 11, 2024 · 1 comment · Fixed by #673
Closed

Improve the Readme of the repository #480

slemeur opened this issue Mar 11, 2024 · 1 comment · Fixed by #673
Assignees
@jeffmaury
Milestone
0.3.0

Comments

@slemeur
Copy link
Contributor

slemeur commented Mar 11, 2024

The readme should explain what the tool is providing:

  • features listing
  • sample to try
  • user guide
  • how to contribute
@slemeur slemeur added this to the 0.3.0 milestone Mar 11, 2024
@jeffmaury jeffmaury self-assigned this Mar 13, 2024
@vrothberg
Copy link
Member

Screenshots and recordings would be great to have as well

jeffmaury added a commit to jeffmaury/ai-lab that referenced this issue Mar 25, 2024
@jeffmaury
fix: improve README.md
4779021 
Fixes containers#480

Signed-off-by: Jeff MAURY <jmaury@redhat.com>
@jeffmaury jeffmaury mentioned this issue Mar 25, 2024
Merged
jeffmaury added a commit that referenced this issue Mar 26, 2024
@jeffmaury @vrothberg
fix: improve README.md (#673)
8709faf 
* fix: improve README.md

Fixes #480

Signed-off-by: Jeff MAURY <jmaury@redhat.com>

* fix: apply suggestions from @vrothberg code review

Co-authored-by: Valentin Rothberg <vrothberg@redhat.com>
Signed-off-by: Jeff MAURY <jmaury@redhat.com>

* fix: reword the memory and CPU requiments paragraph

Signed-off-by: Jeff MAURY <jmaury@redhat.com>

* fix: reword model format sentence

Signed-off-by: Jeff MAURY <jmaury@redhat.com>

* fix: add animations

Signed-off-by: Jeff MAURY <jmaury@redhat.com>

---------

Signed-off-by: Jeff MAURY <jmaury@redhat.com>
Co-authored-by: Valentin Rothberg <vrothberg@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jeffmaury jeffmaury

Labels
None yet
Projects
Podman Desktop Planning
Archived in project
Milestone
0.3.0
Development

Successfully merging a pull request may close this issue.

fix: improve README.md jeffmaury/ai-lab
3 participants
@jeffmaury @slemeur @vrothberg