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

Added usage example to README and index of docs #370

Merged
merged 2 commits into from
May 8, 2023
Merged

Conversation

fpgmaas
Copy link
Owner

@fpgmaas fpgmaas commented May 8, 2023

PR Checklist

  • A description of the changes is added to the description of this PR.
  • If there is a related issue, make sure it is linked to this PR.
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

Description of changes

I think that with the improved output formatting by @mkniewallner it would be good to show a small example of the output in the README and in the homepage of the docs, so new users know what they can expect from the tool.

@fpgmaas fpgmaas requested a review from mkniewallner May 8, 2023 14:18
@codecov
Copy link

codecov bot commented May 8, 2023

Codecov Report

Merging #370 (4397a05) into main (e3608e5) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #370   +/-   ##
=====================================
  Coverage   96.6%   96.6%           
=====================================
  Files         37      37           
  Lines       1040    1040           
  Branches     207     207           
=====================================
  Hits        1005    1005           
  Misses        22      22           
  Partials      13      13           

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@fpgmaas fpgmaas requested a review from mkniewallner May 8, 2023 15:06
@fpgmaas fpgmaas merged commit 6ae3d47 into main May 8, 2023
@fpgmaas fpgmaas deleted the docs/readme branch May 8, 2023 15:18
@fpgmaas fpgmaas mentioned this pull request May 8, 2023
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