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

Update README #528

Merged
merged 5 commits into from
Apr 14, 2023
Merged

Update README #528

merged 5 commits into from
Apr 14, 2023

Conversation

daavoo
Copy link
Contributor

@daavoo daavoo commented Apr 14, 2023

  • Use MarkDown
  • Add Quickstart
  • Add DVC CLI / VSCode / Studio mentions and screenshots

Closes #524

@codecov-commenter
Copy link

Codecov Report

Patch and project coverage have no change.

Comparison is base (3e0ac41) 95.81% compared to head (4b75601) 95.81%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #528   +/-   ##
=======================================
  Coverage   95.81%   95.81%           
=======================================
  Files          41       41           
  Lines        2628     2628           
  Branches      221      221           
=======================================
  Hits         2518     2518           
  Misses         67       67           
  Partials       43       43           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@daavoo daavoo self-assigned this Apr 14, 2023
@daavoo daavoo added the A: docs Area: user documentation label Apr 14, 2023
README.md Show resolved Hide resolved
@@ -1,5 +1,9 @@
* [ ] ❗ I have followed the [Contributing to DVCLive](https://github.com/iterative/dvclive/blob/master/CONTRIBUTING.md) guide.
Copy link
Member

Choose a reason for hiding this comment

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

I think those could be excluded btw. As far as I remember formatting them breaks the rendering in some subtle way. We are excluding them in all the websites.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@daavoo daavoo merged commit b630263 into main Apr 14, 2023
@daavoo daavoo deleted the readme branch April 14, 2023 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve README since dvclive becomes more important
3 participants