source: code/trunk/README.md@ 591

Last change on this file since 591 was 576, checked in by hubert, 4 years ago

Add a C compiler to the list of dependencies

It's needed to build sqlite3.

File size: 1.1 KB
RevLine 
[336]1# [soju]
[2]2
[373]3[![builds.sr.ht status](https://builds.sr.ht/~emersion/soju/commits.svg)](https://builds.sr.ht/~emersion/soju/commits?)
[290]4
[53]5A user-friendly IRC bouncer.
[2]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
[78]13## Usage
14
[522]15* [Getting started]
16* [Man page]
[366]17
[504]18## Building and installing
[366]19
[567]20Dependencies:
21
22- Go
[576]23- a C89 compiler (for SQLite)
[567]24- scdoc (optional, for man pages)
25
[504]26For end users, a `Makefile` is provided:
[366]27
[504]28 make
29 sudo make install
30
31For development, you can use `go run ./cmd/soju` as usual.
32
[53]33## Contributing
34
[123]35Send patches on the [mailing list] or on [GitHub], report bugs on the
[523]36[issue tracker]. Discuss in [#soju on Libera Chat][IRC channel].
[53]37
[2]38## License
39
[52]40AGPLv3, see LICENSE.
41
[337]42Copyright (C) 2020 The soju Contributors
[53]43
[336]44[soju]: https://soju.im
[522]45[Getting started]: doc/getting-started.md
[527]46[Man page]: https://soju.im/doc/soju.1.html
[373]47[mailing list]: https://lists.sr.ht/~emersion/soju-dev
[123]48[GitHub]: https://github.com/emersion/soju
[98]49[issue tracker]: https://todo.sr.ht/~emersion/soju
[523]50[IRC channel]: ircs://irc.libera.chat/#soju
Note: See TracBrowser for help on using the repository browser.