Skip to content

Commit 88d9900

Browse files
committed
Update readme
1 parent 7feebb4 commit 88d9900

1 file changed

Lines changed: 30 additions & 9 deletions

File tree

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,35 @@
1-
Failchat is a desktop application for streamers. It aggregates chat messages from multiple sources, shows you viewer count, etc.
1+
Failchat is a desktop application for streamers. It aggregates chat messages from multiple sources, shows you viewer
2+
count, and more.
23
Detailed description could be found [on the site](https://onoderis.github.io/failchat/).
34

4-
### Requirements
5-
Java 11 with bundled JavaFX. [Liberica JDK](https://bell-sw.com/pages/downloads/#/java-11-lts) is recommended.
5+
### Before you run or build
6+
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)
9+
is
10+
recommended.
11+
12+
13+
2. Create a file `src/main/resources/config/private.properties` with the following properties and replace the values:
614

7-
### Before you build
8-
Create file `src/main/resources/config/private.properties` with the following properties and replace the values:
915
```properties
10-
twitch.bot-name = BOT_NAME
11-
twitch.bot-password = BOT_PASSWORD (has prefix "oauth:")
12-
twitch.client-id = API_TOKEN
13-
twitch.client-secret = CLIENT_SECRET
16+
twitch.bot-name=BOT_NAME
17+
twitch.bot-password=BOT_PASSWORD (has prefix "oauth:")
18+
twitch.client-id=API_TOKEN
19+
twitch.client-secret=CLIENT_SECRET
20+
```
21+
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
26+
27+
```shell
28+
./run.sh
29+
```
30+
31+
### How to build a distributable archive
32+
33+
```shell
34+
mvn package
1435
```

0 commit comments

Comments
 (0)