Skip to content

Commit a5e3bf5

Browse files
committed
Update readme
1 parent 1f85c59 commit a5e3bf5

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ Failchat is a desktop application for streamers. It aggregates chat messages fro
22
count, and more.
33
Detailed description could be found [on the site](https://onoderis.github.io/failchat/).
44

5-
### Before you run or build
5+
### How to build and run
66

7-
1. Java 11 with bundled JavaFX is
8-
required. [Liberica full JDK 11.0.22+12](https://bell-sw.com/pages/downloads/?version=java-11&release=11.0.22%2B12)
7+
1. Install Java 11 with bundled
8+
JavaFX. [Liberica full JDK 11.0.22+12](https://bell-sw.com/pages/downloads/?version=java-11&release=11.0.22%2B12)
99
is
1010
recommended.
1111

@@ -19,16 +19,19 @@ twitch.client-id=API_TOKEN
1919
twitch.client-secret=CLIENT_SECRET
2020
```
2121

22-
3. In order to do `mvn package` you have to put desired JDK to `jdk/` directory. See goal `build-app-runtime` in pom.xml
23-
for additional info.
24-
25-
### How to run
22+
3. Run command
2623

2724
```
2825
mvn compile org.codehaus.mojo:exec-maven-plugin:exec@run-app
2926
```
3027

31-
### How to build a distributable archive
28+
### How to create distributable archives
29+
30+
1. Complete all the steps in "How to run" section.
31+
2. Place windows and linux JDKs in `jdk/` directory. Look at executions `build-windows-runtime` and
32+
`build-linux-runtime` in pom.xml
33+
for additional info.
34+
3. Run command
3235

3336
```
3437
mvn package

0 commit comments

Comments
 (0)