Skip to content

Commit aa09c36

Browse files
authored
Update README.md
1 parent a33e132 commit aa09c36

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
11
# Polystat CLI
22
This repository provides an alternative implementation to [Polystat](https://github.com/polystat/polystat).
33

4-
# Basic usage
4+
# Installation
5+
The CLI is distributed as a fat jar, so that you can run without any prerequisites other than the JRE. To run it, just execute:
6+
```
7+
java -jar polystat.jar <args>
8+
```
9+
It may be helpful to define an alias (the following works in Unix/MacOs):
10+
```
11+
alias polystat="java -jar /path/to/polystat.jar"
12+
```
13+
And then simply run it like:
14+
```
15+
polystat <args>
16+
```
17+
More about the arguments you can pass can be found [here](#basic) and [here](#full).
18+
19+
20+
# <a name="basic"></a> Basic usage
521

622
> `polystat`
723
@@ -37,7 +53,7 @@ Get the plain text console output from analyzing Java files. The Java files are
3753
Write the [SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) JSON files to `polystat_out/sarif` from analysing the `tmp` directory with `.eo` files.
3854

3955

40-
# Full Usage Specification
56+
# <a name="full"></a> Full Usage Specification
4157

4258
## Notation
4359
The description follows [this guide](https://en.wikipedia.org/wiki/Command-line_interface#Command_description_syntax).

0 commit comments

Comments
 (0)