aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: bddb16f322e0d3f71c67396c74ca4ad9364eca54 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.. raw:: html

  <h1 align="center"><code>dos-bot</code></h1>

  <p align="center">

.. image:: https://img.shields.io/discord/854071194453671976
  :alt: Discord
  :target: https://discord.io/assembly

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
  :alt: Say Thanks
  :target: https://saythanks.io/to/[email protected]

.. image:: https://img.shields.io/github/license/fuwn/dos-bot
  :alt: License
  :target: ./LICENSE

.. raw:: html

  </p>

Usage
-----

Docker
~~~~~~

.. code-block:: shell

  $ docker run --name DosBot -v /var/lib/dos-bot:/.dos-bot fuwn/dos-bot

Docker Compose
~~~~~~~~~~~~~~

.. code-block:: shell

  $ docker-compose up -d

Invite
~~~~~~

https://discord.com/api/oauth2/authorize?client_id=857695800677892106&permissions=8&scope=bot

Development Dependencies
------------------------

Required
~~~~~~~~

- `Rust <https://www.rust-lang.org/>`_ — The backbone of it all.
- `cargo-make <https://github.com/sagiegurari/cargo-make>`_ — Cross-platform
  `make <https://www.gnu.org/software/make/>`_ substitute

Optional
~~~~~~~~

- `cargo-watch <https://crates.io/crates/cargo-watch>`_ — Recompilation on file-system changes

*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are
using the Nix shell configuration as provided.*

License
~~~~~~~

`GNU General Public License v3.0 <./LICENSE>`_