Description:
Add very rudimentary README.
Commit status:
[Not Reviewed]
References:
Diff options:
Comments:
0 Commit comments
0 Inline Comments
Unresolved TODOs:
There are no unresolved TODOs
Author
-
| @@ -1,6 +1,6 | |||||
|
|
1 | # project-checkup |
|
1 | # project-checkup |
|
|
2 |
|
2 | ||
|
|
3 | FIXME: description |
|
3 | A small tool to make sure all your ducks are in a row in your project. |
|
|
4 |
|
4 | ||
|
|
5 | ## Installation |
|
5 | ## Installation |
|
|
6 |
|
6 | ||
| @@ -8,29 +8,17 | |||||
|
|
8 |
|
8 | ||
|
|
9 | ## Usage |
|
9 | ## Usage |
|
|
10 |
|
10 | ||
|
|
11 | FIXME: explanation |
|
11 | Run the issue: |
|
|
12 |
|
12 | ||
|
|
13 |
$ java -jar project-checkup-0.1. |
|
13 | $ java -jar project-checkup-0.1.2-standalone.jar [args] |
|
|
14 |
|
14 | ||
|
|
15 | ## Options |
|
15 | ## Options |
|
|
16 |
|
16 | ||
|
|
17 | FIXME: listing of options this app accepts. |
|
17 | FIXME: listing of options this app accepts. |
|
|
18 |
|
18 | ||
|
|
19 | ## Examples |
|
||
|
|
20 |
|
|||
|
|
21 | ... |
|
||
|
|
22 |
|
|||
|
|
23 | ### Bugs |
|
||
|
|
24 |
|
|||
|
|
25 | ... |
|
||
|
|
26 |
|
|||
|
|
27 | ### Any Other Sections |
|
||
|
|
28 | ### That You Think |
|
||
|
|
29 | ### Might be Useful |
|
||
|
|
30 |
|
|||
|
|
31 | ## License |
|
19 | ## License |
|
|
32 |
|
20 | ||
|
|
33 |
Copyright © 2018 |
|
21 | Copyright © 2018 Alys Brooks |
|
|
34 |
|
22 | ||
|
|
35 | Distributed under the Eclipse Public License either version 1.0 or (at |
|
23 | Distributed under the Eclipse Public License either version 1.0 or (at |
|
|
36 | your option) any later version. |
|
24 | your option) any later version. |
You need to be logged in to leave comments.
Login now