Skip to content

Commit bcda374

Browse files
committed
Update readme to mention precompiled jar
1 parent 234b950 commit bcda374

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,24 +45,26 @@ read all messages in its groups. If privacy mode is enabled, the bot won't be ab
4545
deletemydata - Delete your Markov chain data in this group
4646
deletemessagedata - Delete a message from your Markov chain data in this group
4747
deleteuserdata - (Admin only) Delete a user's Markov chain data in this group
48-
49-
Now you will need to build some code. The project uses [Maven](https://maven.apache.org/), so get that installed if you
50-
haven't already. Download the latest source code for markov-telegram-bot. Unzip it, enter a command line in the root
51-
`markov-telegram-bot` directory and run `mvn clean package`. Two jars will be generated in the `target` directory; you
52-
need the `jar-with-dependencies` one.
48+
49+
Download the precompiled jar file from the latest [release](https://github.com/ClockVapor/markov-telegram-bot/releases)
50+
or build it yourself with Maven if you like. If you aren't building it yourself, skip the next paragraph.
51+
52+
To build the code yourself, get [Maven](https://maven.apache.org/) installed if you haven't already. Download the latest
53+
source code for markov-telegram-bot. Unzip it, enter a command line in the root `markov-telegram-bot` directory and run
54+
`mvn clean package`. Two jars will be generated in the `target` directory; you need the `jar-with-dependencies` one.
5355

5456
Create a folder wherever you want to store the bot's files. Copy the `jar-with-dependencies` into this folder, and create a YAML
5557
file in there too with the following contents:
5658

5759
telegramBotToken: <your bot token>
58-
60+
5961
Replace `<your bot token>` with the token @BotFather gave you when you created your bot. I call this file `config.yml`, but you
6062
can use any name you want.
6163

6264
Now you're ready to run the bot. Open a command line inside your bot folder and run the following command:
6365

6466
java -jar <jar path> -c <config yml path> -d <data directory path>
65-
67+
6668
Replace `<jar path>` with the name of the `jar-with-dependencies` file you copied into the folder, `<config yml path>` with the
6769
name of the YAML file you created in the folder, and `<data directory path>` with whatever path you want to store the bot's
6870
Markov chain data in (I just use `data`).

0 commit comments

Comments
 (0)