|
Last change
on this file since 534 was 527, checked in by contact, 4 years ago |
|
readme: link to rendered man page
|
|
File size:
1.1 KB
|
| Line | |
|---|
| 1 | # [soju]
|
|---|
| 2 |
|
|---|
| 3 | [](https://builds.sr.ht/~emersion/soju/commits?)
|
|---|
| 4 |
|
|---|
| 5 | A 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 |
|
|---|
| 20 | For end users, a `Makefile` is provided:
|
|---|
| 21 |
|
|---|
| 22 | make
|
|---|
| 23 | sudo make install
|
|---|
| 24 |
|
|---|
| 25 | For development, you can use `go run ./cmd/soju` as usual.
|
|---|
| 26 |
|
|---|
| 27 | ## Contributing
|
|---|
| 28 |
|
|---|
| 29 | Send patches on the [mailing list] or on [GitHub], report bugs on the
|
|---|
| 30 | [issue tracker]. Discuss in [#soju on Libera Chat][IRC channel].
|
|---|
| 31 |
|
|---|
| 32 | ## License
|
|---|
| 33 |
|
|---|
| 34 | AGPLv3, see LICENSE.
|
|---|
| 35 |
|
|---|
| 36 | Copyright (C) 2020 The soju Contributors
|
|---|
| 37 |
|
|---|
| 38 | [soju]: https://soju.im
|
|---|
| 39 | [Getting started]: doc/getting-started.md
|
|---|
| 40 | [Man page]: https://soju.im/doc/soju.1.html
|
|---|
| 41 | [mailing list]: https://lists.sr.ht/~emersion/soju-dev
|
|---|
| 42 | [GitHub]: https://github.com/emersion/soju
|
|---|
| 43 | [issue tracker]: https://todo.sr.ht/~emersion/soju
|
|---|
| 44 | [IRC channel]: ircs://irc.libera.chat/#soju
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
