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