40 lines
911 B
Markdown
40 lines
911 B
Markdown
# Grand Unified Software Quality Tool
|
|
|
|
Intended to be a wrapper into which many software quality tools can be plugged, and which will produce two separate outputs:
|
|
|
|
1. an EDN map, integrating all the issues found be any of the tools, which can be parsed by an IDE to provide located notfications;
|
|
2. A directory of human-readable, Markdown or HTML, documentation, including not only docstrings culled from the source but also test output, coverage, linter warnings, etc.
|
|
|
|
## Installation
|
|
|
|
Download from http://example.com/FIXME.
|
|
|
|
## Usage
|
|
|
|
FIXME: explanation
|
|
|
|
$ java -jar gusqt-0.1.0-standalone.jar [args]
|
|
|
|
## Options
|
|
|
|
FIXME: listing of options this app accepts.
|
|
|
|
## Examples
|
|
|
|
...
|
|
|
|
### Bugs
|
|
|
|
...
|
|
|
|
### Any Other Sections
|
|
### That You Think
|
|
### Might be Useful
|
|
|
|
## License
|
|
|
|
Copyright © 2019 Simon Brooke
|
|
|
|
Distributed under the Eclipse Public License either version 1.0 or (at
|
|
your option) any later version.
|