-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5439278
commit c5c0644
Showing
1 changed file
with
21 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,26 @@ | ||
# Yomer | ||
|
||
Yomer is a Discord voice bot to speak out text messages sent to text channels. | ||
|
||
## Deploy | ||
|
||
The easiest way is to use Docker Compose. | ||
|
||
TBD | ||
|
||
## Usage | ||
|
||
Text `!ymr join` to join Yomer to your voice channel. Yomer will then read all text messages aloud. Use `!ymr leave` to make Yomer leave your channel. | ||
|
||
## Build locally | ||
|
||
Set up [OPAM](https://opam.ocaml.org/) first. Then, run the following steps: | ||
|
||
``` | ||
opam switch create . --no-install | ||
opam pin cohttp https://github.com/ushitora-anqou/ocaml-cohttp.git#yomer | ||
opam pin cohttp-eio https://github.com/ushitora-anqou/ocaml-cohttp.git#yomer | ||
opam pin websocket https://github.com/ushitora-anqou/ocaml-websocket.git#eio | ||
#opam pin websocket-eio https://github.com/ushitora-anqou/ocaml-websocket.git#eio | ||
opam pin sodium https://github.com/ushitora-anqou/ocaml-sodium.git#yomer | ||
opam switch create --no-install . 5.1.0 | ||
opam pin cohttp https://github.com/mirage/ocaml-cohttp.git#v6.0.0_beta1 | ||
opam pin cohttp-eio https://github.com/mirage/ocaml-cohttp.git#v6.0.0_beta1 | ||
opam pin sodium https://github.com/ahrefs/ocaml-sodium.git#734eccbb47e7545a459a504188f1da8dc0bd018e | ||
opam install . --deps-only | ||
dune build bin/main.exe | ||
``` |