source: code/trunk/README.md@ 813

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

feat: replace mattn/go-sqlite3 with modernc.org/sqlite - this also means CGo is not needed anymore

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
[567]19- scdoc (optional, for man pages)
20
[504]21For end users, a `Makefile` is provided:
[366]22
[504]23 make
[801]24 doas make install
[504]25
[801]26For development, you can use `go run ./cmd/suika` as usual.
[504]27
[2]28## License
[813]29AGPLv3, see [LICENSE](LICENSE).
[2]30
[813]31* Copyright (C) 2020 The soju Contributors
32* Copyright (C) 2023-present Aoi K.
[52]33
[810]34The 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.