songy

telegram bot as a songbook
git clone git://git.relim.de/songy.git
Log | Files | Refs | README | LICENSE

commit 4391eafb58e66b7fd5f9265ea0c295ec0808d8a3
parent b3627ae7baf9f020440010610bf126fbf9df9a3e
Author: devnibo <kroekerrobin@gmail.com>
Date:   Mon, 10 Jul 2023 09:59:03 +0200

Rename repo from 'songs' to 'songy'

Diffstat:
M.gitignore | 2+-
MCargo.toml | 2+-
MREADME.md | 14+++++++-------
Mbuild_for_release.sh | 4++--
4 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -1,3 +1,3 @@ /target # all release builds -songs_v* +songy_v* diff --git a/Cargo.toml b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "songs" +name = "songy" version = "1.0.6" edition = "2021" diff --git a/README.md b/README.md @@ -1,4 +1,4 @@ -# songs +# songy This is a telegram bot written in [rust](https://www.rust-lang.org/) using the [frankenstein](https://github.com/ayrat555/frankenstein) telegram bot library. @@ -6,7 +6,7 @@ This is a telegram bot written in [rust](https://www.rust-lang.org/) using the [ This bot provides an interface to files. It is meant to be used as a digital songbook. -<img src="https://github.com/devrobinkroeker/songs/raw/master/example.gif" alt="example" height="600" /> +<img src="https://github.com/devnibo/songy/raw/master/example.gif" alt="example" height="600" /> ### bot commands @@ -15,7 +15,7 @@ The `/list` command lists all available files in the provided --songs-path recur ## installation -1. Download the [latest release](https://github.com/devrobinkroeker/songs/releases) executable +1. Download the [latest release](https://github.com/devnibo/songy/releases) executable 2. Decide about the configuration 1. [Create a telegram bot](https://telegram.me/BotFather) to obtain the bot api token (--token) 2. Which language do you want the bot to speak? english, german or moldovan (--lang) @@ -26,17 +26,17 @@ The `/list` command lists all available files in the provided --songs-path recur As the bot has to run endlessly you probably want to create some sort of background service. Here's a simple solution I use. -1. `sudo touch /etc/systemd/system/songs.service` -2. Copy this into `songs.service` +1. `sudo touch /etc/systemd/system/songy.service` +2. Copy this into `songy.service` ``` [Unit] Description=Digital song book [Service] -ExecStart=/full/path/to/songs/executable --token <api_token> --songs-path <full/path/to/songs/folder> --lang <en|de|md> +ExecStart=/full/path/to/songy/executable --token <api_token> --songs-path <full/path/to/songs/folder> --lang <en|de|md> Restart=on-failure [Install] WantedBy=default.target ``` -3. `systemctl start songs` +3. `systemctl start songy` diff --git a/build_for_release.sh b/build_for_release.sh @@ -8,8 +8,8 @@ test ${versionNumber:0:1} != "v" && versionNumber="v""$versionNumber" declare -a cmds=( "git tag $versionNumber" "cargo build -r --target x86_64-unknown-linux-musl" - "cp target/x86_64-unknown-linux-musl/release/songs ." - "mv songs songs_"$versionNumber"_x86_64-unknown-linux-musl" + "cp target/x86_64-unknown-linux-musl/release/songy ." + "mv songy songy_"$versionNumber"_x86_64-unknown-linux-musl" ) for (( i=0; i<${#cmds[@]}; i++ )); do