jawher / mow.cli / 204 / 2
95%
master: 95%

DEFAULT BRANCH: master
Ran
Files 19
Run time 0s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 95.992%. Remained the same
204.2

push

travis-ci

jawher 
Unify package doc and github README.md (#72)

MOTIVATION

Prior to this set of changes, two sets of documentation had to be maintained:
the GitHub README.md and the Go package documentation in doc.go.  The README.md
file is a superset of documentation that includes the following items:

- Various badge icons (build, godoc, coverage)
- Getting started guide with sample applications
- Comparison to other CLI tools
- Installation instructions
- A copy of the package doc.go
- License information

Because a copy of doc.go was included in README.md, over time these two versions
have diverged.  Committers updating README.md would forget to submit the same
patches to doc.go and vice versa.  Further complicating the situation is that
GitHub markdown is more featureful (multi-level headings, lists, etc ...) than
the simple and straightforward Go doc standards.  Consequently, the package
documentation (doc.go) contained within README.md acquired additional markup,
further cementing the need to maintain two slightly different versions of the
package documentation.

Due to the above issues, contributing to the project's documentation was not an
easy task. If done properly, a contributor would have to update the README.md
document and then update the doc.go package documentation stripping out the
markdown.  This assumes the contributor was editing a portion of the docs that
had not diverged over time.  In that case, additional work was required to
synchronize the documents.

CHANGES

This commit includes several changes to improve the overall documentation of
the mow.cli project. Below is a short summary of each:

- To eliminate the need to maintain two sets of nearly identical docs, the
  README.md file is now autogenerated using the Go autoreadme package. This
  tool generates a README.md from a README.md.template file. The template
  file includes all of the original README.md content (described above), but
  also includes p... (continued)

1389 of 1447 relevant lines covered (95.99%)

1.08 hits per line

Source Files on job 204.2