Skip to content

Commit 77a538d

Browse files
committed
simplified headings
1 parent 4a9586a commit 77a538d

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,14 +176,13 @@ The example of the working config file can be found [here](.polystat.conf).
176176
* `polystat.outputs.files` - a list of files to write aggregated output to.
177177
178178
# Development
179-
## Setup
180-
This is an sbt Scala project. In order to build the project you need the following:
179+
Polystat CLI is an sbt Scala project. In order to build the project you need the following:
181180
* [JDK](https://ru.wikipedia.org/wiki/Java_Development_Kit) 8+
182181
* [sbt](https://www.scala-sbt.org/) 1.6.2
183182
184183
Both can be easily fetched via [coursier](https://get-coursier.io/docs/overview).
185184
186-
## Running the CLI
185+
Running the CLI:
187186
```
188187
$ sbt run
189188
```
@@ -192,14 +191,14 @@ It's best to run this command in the interactive mode, because you can specify t
192191
However, for better turnaround time, it's better to tailor the `.polystat.conf` in the repository root for your needs and just run `run`.
193192
If you want to change the command-line arguments, edit the `.polystat.conf` in the repository root.
194193
195-
## Generating the fat JAR
194+
The following command can be used to generate the fat JAR file.
196195
```
197196
$ sbt assembly
198197
```
199198
200-
The generated jar can be then found at `target/scala-3.1.2/polystat.jar`.
199+
The generated `.jar` file can be then found at `target/scala-3.1.2/polystat.jar`.
201200
202-
## Running the tests
201+
To run the tests use the relevant `sbt` task:
203202
```
204203
$ sbt test
205204
```

0 commit comments

Comments
 (0)