From 7edba2d10f980016462f917c6d21d64585ddfd6b Mon Sep 17 00:00:00 2001
From: Adam Izraelevitz
Date: Fri, 21 Aug 2020 12:02:26 -0700
Subject: Added website docs and mdoc. (#1560)

* Added website docs and mdoc. Removed all warnings

* Updated README and added build to circle ci

* Added how to build documentation, deprecated wiki

* Fix copypasta

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>---
 docs/src/wiki-deprecated/test-coverage.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 docs/src/wiki-deprecated/test-coverage.md

(limited to 'docs/src/wiki-deprecated/test-coverage.md')

diff --git a/docs/src/wiki-deprecated/test-coverage.md b/docs/src/wiki-deprecated/test-coverage.md
new file mode 100644
index 00000000..a3a622a2
--- /dev/null
+++ b/docs/src/wiki-deprecated/test-coverage.md
@@ -0,0 +1,21 @@
+---
+layout: docs
+title:  "Test Coverage"
+section: "chisel3"
+---
+
+## Test Coverage Setup
+
+Chisel's sbt build instructions contain the requisite plug-in (sbt-scoverage) for generating test coverage information. Please see the [sbt-scoverage web page](https://github.com/scoverage/sbt-scoverage) for details on the plug-in.
+The tests themselves are found in `src/test/scala`.
+
+## Generating A Test Coverage Report
+
+Use the following sequence of sbt commands to generate a test coverage report:
+```
+sbt clean coverage test
+sbt coverageReport
+```
+The coverage reports should be found in `target/scala-x.yy/scoverage-report/{scoverage.xml,index.html}` where `x.yy` corresponds to the version of Scala used to compile Firrtl and the tests.
+`scoverage.xml` is useful if you want to analyze the results programmatically.
+`index.html` is designed for navigation with a web browser, allowing one to drill down to invidual statements covered (or not) by the tests.
-- 
cgit v1.2.3