diff options
| author | Catlinman <contact@catlinman.com> | 2020-03-24 01:49:43 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-24 01:49:43 +0100 |
| commit | 972534d5e065c88a39e2e19f0491fa963b8b699f (patch) | |
| tree | 77725d1d91222afe8d23cf565458e6f69c269e4d | |
| parent | 6fa137726286edaebd60835b9a5e05a13135d313 (diff) | |
| parent | f098dc867a73d62955507182f49e7569b86e8b27 (diff) | |
| download | pokebot-972534d5e065c88a39e2e19f0491fa963b8b699f.tar.gz pokebot-972534d5e065c88a39e2e19f0491fa963b8b699f.zip | |
Merge pull request #51 from Mavulp/extend-readme
Add compilation instructions
| -rw-r--r-- | Cargo.lock | 2 | ||||
| -rw-r--r-- | README.md | 30 |
2 files changed, 26 insertions, 6 deletions
@@ -2353,7 +2353,7 @@ checksum = "05da548ad6865900e60eaba7f589cc0783590a92e940c26953ff81ddbab2d677" [[package]] name = "pokebot" -version = "0.1.1" +version = "0.2.0" dependencies = [ "actix", "actix-files", @@ -1,7 +1,7 @@ # pokebot ``` -pokebot 0.1.1 +pokebot 0.2.0 Jokler <jokler@protonmail.com> USAGE: @@ -14,14 +14,15 @@ FLAGS: -v, --verbose Print the content of all packets OPTIONS: - -a, --address <address> The address of the server to connect to - -g, --generate-identities <gen_id_count> Generate 'count' identities - -d, --master_channel <master_channel> The channel the master bot should connect to + -a, --address <address> The address of the server to connect to + -g, --generate-identities <gen_id_count> Generate 'count' identities + -d, --master_channel <master_channel> The channel the master bot should connect to + -w, --increase-security-level <wanted_level> Increases the security level of all identities in the config file ARGS: <config_path> Configuration file [default: config.toml] ``` -# Usage +## Usage 1. Poke the main bot. 2. Once the secondary bot joins your channel, type !help for a list of commands. @@ -40,3 +41,22 @@ ARGS: stop Stops audio playback volume Changes the volume to the specified value ``` + +## Compiling + +1. Make sure the following are installed + * cargo + rustc 1.42 or later + * `gstreamer` development libraries which should be `libgstreamer-dev` and `libgstreamer-plugins-base-dev` + +2. Clone the source with `git`: + ```sh + $ git clone https://github.com/Mavulp/pokebot.git + $ cd pokebot + ``` + +3. Building the binary + ```sh + $ cargo build --release + ``` + + This creates the binary under `target/release/`. |