Skip to content

Commit 307f988

Browse files
committed
Update README.md
1 parent c76ba48 commit 307f988

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,36 @@ The JUnit framework is used to write tests. I also use Make & Makefile for frequ
2020

2121
### Test Coverage badge from Code Climate
2222
[![Test Coverage](https://api.codeclimate.com/v1/badges/644d800d4484e158c119/test_coverage)](https://codeclimate.com/github/hopetoknow/java-project-lvl2/test_coverage)
23+
24+
## Install
25+
```sh
26+
make
27+
```
28+
29+
## Run
30+
```sh
31+
cd build/install/app/bin/
32+
./app [-hV] [-f=format] <filepath1> <filepath2>
33+
```
34+
```sh
35+
<filepath1> path to first file
36+
<filepath2> path to second file
37+
-f, --format=format output format [default: stylish] Possible values: stylish, plain, json.
38+
-h, --help Show this help message and exit.
39+
-V, --version Print version information and exit.
40+
```
41+
42+
## Build
43+
```sh
44+
make build
45+
```
46+
47+
## Run checkstyle
48+
```sh
49+
make lint
50+
```
51+
52+
## Check for Dependency Updates
53+
```sh
54+
make check-updates
55+
```

0 commit comments

Comments
 (0)