diff --git a/README.md b/README.md index acb031c..8091ac1 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,16 @@ JavaFX application for easy cut and send audio to Telegram chat as voice message - `ffmpeg` with libopus encoder -## Building and running +## Building -1. Build jar with dependencies: `./gradlew shadowJar` -2. Edit `app.properties` in `build/libs/Voicyanski-all.jar` archive -3. Set `telegram-bot-token` and `telegram-chat-id` properties -4. Run application: - `java -jar Voicyanski-all.jar` and drop your audio file window - or run `java -jar Voicyanski-all.jar path-to-audio-file.mp3` \ No newline at end of file +Build jar with dependencies: `./gradlew shadowJar`. The executable jar will appear as `build/libs/Voicyanski-all.jar` + +## Configuration + +1. Open .jar file as zip archive and edit `app.properties`. +2. Set `telegram-bot-token` and `telegram-chat-id` properties +3. Also you can copy `app.properties` to `%home%/.config/voicyanski.conf`. This file will be read first. You don't need to fill in all props because missing props will fallback to `app.properties`. + +## Running + +Run `java -jar Voicyanski-all.jar` and drag&drop your music file on the app's window or run `java -jar Voicyanski-all.jar `. Supported formats: MP3, AAC, WAV diff --git a/gradlew b/gradlew old mode 100644 new mode 100755