source: code/trunk/README.md@ 572

Last change on this file since 572 was 567, checked in by contact, 4 years ago

readme: list dependencies

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