Merge pull request #9 from TomPed/master

Updated README

Author: Steve Peak

README.md

@@ -1,69 +1,11 @@
-# Codecov Rust Example [![travisCI](https://travis-ci.org/codecov/example-rust.svg)](https://travis-ci.org/codecov/example-rust) [![codecov.io](http://codecov.io/github/codecov/example-rust/coverage.svg?branch=master)](http://codecov.io/github/codecov/example-rust?branch=master)
-
-| [https://codecov.io][1] | [@codecov][2] | [[email protected]][3] |
-| ----------------------- | ------------- | --------------------- |
-
-This repository serves as an **example** of how to use [the Codecov global
-uploader][4] with Rust.
-
-Note that the coverage is deliberately incomplete. That
-way you can [follow the badge link][5] and see how [Codecov][1]
-works. You can view the code there, see hits and misses for coverage, etc.
+# [Codecov][1] Rust Example
 
 **As of July 2, 2016, there is [no option to make rustdoc generate a runnable test executable][7]. That means that documentation tests will not show in your coverage data. If you discover a way to run the doctest executable with kcov, please open an [Issue][8] and we will add that to these instructions.**
 
-## Basic Usage
-
-Run your tests with [kcov][6] in order to create the necessary coverage
-reports. For example:
-
-```
-kcov --exclude-pattern=/.cargo,/usr/lib --verify target/cov target/debug/<PROJECT-NAME>-<hash>
-```
-
-`<PROJECT-NAME>` and `<hash>` are the appropriate project name and hash for
-your executable.
-
-The hash at the end may change if cargo generates different test
-executables with the same name. If you are building your code
-differently or without cargo, change the last two arguments
-to kcov to respectively represent where you want the coverage to
-be stored and which executable to run.
-
-Attempting to run `kcov` with an executable argument ending in a wildcard
-like `<PROJECT-NAME>-*` may result in incorrect coverage results as only a
-single test executable will run. **For best results, run the kcov command
-for each test executable and store the results in separate directories.**
-Codecov will automatically find and upload the cobertura.xml files and
-merge the coverage for you.
-
-Note that setting the environment variable `RUSTFLAGS="-C link-dead-code"`
-during tests build may improve coverage accuracy by preventing dead-code elimination.
-Do not set this variable when creating release builds since it will increase
-binary size.
-
-After you've run the tests and created a cobertura.xml report, you can
-use [the Codecov global uploader][4] to push that report to Codecov.
-See below for further details.
-
-Installing `kcov` is largely dependent on your operating system. It is
-demonstrated to work on Linux systems but may not be fully compatible with
-Windows or OS X. Please lookup the appropriate installation instructions.
-The Travis CI example below demonstrates installing `kcov` on a Linux
-computer.
-
-The version of `kcov` that is distributed with your package manager may not
-work with Rust binaries. You usually need to manually build the latest
-master branch and run kcov from there. All of this is taken care of for you
-in the `.travis.yml` file below.
-
-## [![travis-org](https://avatars2.githubusercontent.com/u/639823?v=2&s=50)](https://travis-ci.org) Travis CI
-
-### Public Repos
-
-Adjust the following example `.travis.yml` file to test with the versions
-of Rust you desire.
+## Guide
+### Travis Setup
 
+Add to your `.travis.yml` file.
 ```yml
 language: rust
 
@@ -108,44 +50,82 @@ after_success: |
   bash <(curl -s https://codecov.io/bash) &&
   echo "Uploaded code coverage"
 ```
+This will automatically run each executable and store the results in a
+different directory. Codecov will automatically find the `cobertura.xml`
+files that `kcov` generates and combine the results.
 
-[Codecov][1] is integrated by the following line in `after_success:`.
+#### Other CI services
+- Adjust the materials in the above example as necessary for your CI.
+- Add CODECOV_TOKEN=<your repo token> to your CI's environment variables. (Don't store the raw token in your repo.)
+- Run bash <(curl -s https://codecov.io/bash) after tests complete.
+
+### Produce Coverage Reports
+
+Run your tests with [kcov][6] in order to create the necessary coverage
+reports. For example:
 
-```yml
-bash <(curl -s https://codecov.io/bash)
+```
+kcov --exclude-pattern=/.cargo,/usr/lib --verify target/cov target/debug/<PROJECT-NAME>-<hash>
 ```
 
-This will automatically run each executable and store the results in a
-different directory. Codecov will automatically find the `cobertura.xml`
-files that `kcov` generates and combine the results.
+`<PROJECT-NAME>` and `<hash>` are the appropriate project name and hash for
+your executable.
 
-### Private Repos
+The hash at the end may change if cargo generates different test
+executables with the same name. If you are building your code
+differently or without cargo, change the last two arguments
+to kcov to respectively represent where you want the coverage to
+be stored and which executable to run.
 
-Add to your `.travis.yml` file.
+Attempting to run `kcov` with an executable argument ending in a wildcard
+like `<PROJECT-NAME>-*` may result in incorrect coverage results as only a
+single test executable will run. **For best results, run the kcov command
+for each test executable and store the results in separate directories.**
+Codecov will automatically find and upload the cobertura.xml files and
+merge the coverage for you.
+
+Note that setting the environment variable `RUSTFLAGS="-C link-dead-code"`
+during tests build may improve coverage accuracy by preventing dead-code elimination.
+Do not set this variable when creating release builds since it will increase
+binary size.
 
+After you've run the tests and created a cobertura.xml report, you can
+use [the Codecov global uploader][4] to push that report to Codecov.
+See below for further details.
+
+Installing `kcov` is largely dependent on your operating system. It is
+demonstrated to work on Linux systems but may not be fully compatible with
+Windows or OS X. Please lookup the appropriate installation instructions.
+The Travis CI example below demonstrates installing `kcov` on a Linux
+computer.
+
+## Caveats
+### Private Repos
+Add to your `.travis.yml` file.
 ```yml
-env:
-  global:
-    - CODECOV_TOKEN=:uuid-repo-token
+after_success:
+  - bash <(curl -s https://codecov.io/bash) -t uuid-repo-token
 ```
+### `kcov` Version
+
+The version of `kcov` that is distributed with your package manager may not
+work with Rust binaries. You usually need to manually build the latest
+master branch and run kcov from there. All of this is taken care of for you
+in the `.travis.yml` file.
+## Support
 
-## Other CI services
+### Contact
+- Intercom (in-app messanger)
+- Email: [[email protected]](mailto:[email protected])
+- Slack: [slack.codecov.io](https://slack.codecov.io)
+- [gh/codecov/support](https://github.com/codecov/support)
 
-+ Adjust the materials in the above example as necessary for
-  your CI.
-+ Add `CODECOV_TOKEN=<your repo token>` to your CI's environment variables.
-  (Don't store the raw token in your repo.)
-+ Run `bash <(curl -s https://codecov.io/bash)` after tests complete.
+1. More documentation at https://docs.codecov.io
+2. Configure codecov through the `codecov.yml`  https://docs.codecov.io/docs/codecov-yaml
 
-## More details
 
-Visit [the global uploader's repo][4] to view its source and
-learn more about the script.
 
-[1]: https://codecov.io
-[2]: https://twitter.com/codecov
-[3]: mailto:[email protected]
-[4]: https://github.com/codecov/codecov-bash
+[1]: https://codecov.io/
 [5]: http://codecov.io/github/codecov/example-rust?branch=master
 [6]: https://simonkagstrom.github.io/kcov/
 [7]: http://stackoverflow.com/questions/35547710/does-rustdoc-generate-runnable-binaries