source: code/trunk/README.md@ 812

Last change on this file since 812 was 812, checked in by koizumi.aoi, 2 years ago

Update README

Signed-off-by: Aoi K <koizumi.aoi@…>

File size: 1.1 KB
RevLine 
[801]1# suika
[2]2
[812]3[![Go Documentation](https://godocs.io/marisa.chaotic.ninja/suika?status.svg)](https://godocs.io/marisa.chaotic.ninja/suika)
4
[801]5A user-friendly IRC bouncer. Hard-fork of the 0.3 series of [soju](https://soju.im), named after [Suika Ibuki](https://en.touhouwiki.net/wiki/Suika_Ibuki) from [Touhou 7.5: Immaterial and Missing Power](https://en.touhouwiki.net/wiki/Immaterial_and_Missing_Power)
[290]6
[53]7- Multi-user
8- Support multiple clients for a single user, with proper backlog
9 synchronization
10- Support connecting to multiple upstream servers via a single IRC connection
11 to the bouncer
12
[504]13## Building and installing
[366]14
[567]15Dependencies:
16
17- Go
[775]18- BSD or GNU make
[576]19- a C89 compiler (for SQLite)
[567]20- scdoc (optional, for man pages)
21
[504]22For end users, a `Makefile` is provided:
[366]23
[504]24 make
[801]25 doas make install
[504]26
[801]27For development, you can use `go run ./cmd/suika` as usual.
[504]28
[775]29To link with the system libsqlite3, set `GOFLAGS="-tags=libsqlite3"`.
[593]30
[2]31## License
32
[52]33AGPLv3, see LICENSE.
34
[337]35Copyright (C) 2020 The soju Contributors
[801]36Copyright (C) 2023-present Aoi K.
[53]37
[810]38The code for `version.go` is stolen verbatim from one of [@prologic](https://git.mills.io/prologic)'s projects. It's probably under MIT
Note: See TracBrowser for help on using the repository browser.