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

Documentation improvement #249

Open
dalibor-matura opened this Issue Feb 1, 2019 · 3 comments

Comments

Projects
None yet
2 participants
@dalibor-matura
Copy link

dalibor-matura commented Feb 1, 2019

The Readme contains just a minimal usage information and almost no examples.

I would like to get my standard Rust lib.rs project connected with CodeCov (https://codecov.io/), so I would like to gather the Test Coverage data with grcov and send it to CodeCov.

The only information provided on this topic in Readme is:

Coveralls/Codecov output

grcov ~/Documents/FD/mozilla-central/build -t coveralls -s ~/Documents/FD/mozilla-central --token YOUR_COVERALLS_TOKEN > coveralls.json

and I don't know what the directories should I used in my case instead of the

  • ~/Documents/FD/mozilla-central/build
  • ~/Documents/FD/mozilla-central should

It would be nice to provide more detailed description. I'm willing to help and I've already cloned this repo and will look/search through the codebase to get better understanding how it works.

Thanks for a cool tool ;)

@dalibor-matura

This comment has been minimized.

Copy link
Author

dalibor-matura commented Feb 1, 2019

Here's a related Rust Users forum topic I've just created: https://users.rust-lang.org/t/test-coverage-with-grcov/24851

@marco-c

This comment has been minimized.

Copy link
Member

marco-c commented Feb 4, 2019

Thanks @dalibor-matura!

You can use the Travis or Appveyor config as examples (since we are collecting coverage for grcov itself).

@marco-c

This comment has been minimized.

Copy link
Member

marco-c commented Feb 4, 2019

@calixteman improved the docs a little by adding an example of how to use grcov on Travis with #250.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment