48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# zigeru
|
|
|
|
zigeru is a IRC bot which implements the following commands:
|
|
|
|
- `s/OLD/NEW/` -- posts the previous message by the user, where every
|
|
occurrence of OLD is replaced by NEW.
|
|
|
|
```
|
|
00:04 <jassob> hello, world
|
|
00:05 <jassob> s/world/IRC/
|
|
00:05 <@eru> jassob: "hello, IRC"
|
|
```
|
|
|
|
- `!help` -- post a usage string as a response.
|
|
|
|
```
|
|
00:05 <jassob> !help
|
|
00:05 <@eru> Send `s/TYPO/CORRECTION/` to replace TYPO with CORRECTION in your last message.
|
|
```
|
|
|
|
- `!join #CHANNEL` -- make zigeru join #CHANNEL.
|
|
|
|
```
|
|
# in #eru-test2
|
|
00:06 <jassob> !join #eru-test3
|
|
|
|
# in #eru-test3
|
|
00:06 --> jassob (~u@6wh6sdzhnfjx4.dtek.se) has joined #eru-test3
|
|
00:06 -- Channel #eru-test3: 2 nicks (0 owners, 0 admins, 1 op, 0 halfops, 0 voiced, 1 regular)
|
|
00:06 -- Channel created on ons, 11 mar 2026 00:06:44
|
|
```
|
|
|
|
## Getting started
|
|
|
|
To enter into a development shell with all the tools needed for
|
|
interacting with this project, run the following command:
|
|
|
|
```
|
|
$ nix develop
|
|
```
|
|
|
|
To run the tests: `zig build test`.
|
|
|
|
To run the binary: `zig build run`.
|
|
|
|
To build the binary: `zig build`.
|
|
|
|
To build the binary statically: `zig build -Dtarget=x86_64-linux-musl`
|