source: code/trunk/README.md@ 800

Last change on this file since 800 was 775, checked in by contact, 3 years ago

makefile: switch to BSD/GNU make

Let's stop using POSIX make, it's too much of a pain.

File size: 1.2 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- BSD or GNU make
24- a C89 compiler (for SQLite)
25- scdoc (optional, for man pages)
26
27For end users, a `Makefile` is provided:
28
29 make
30 sudo make install
31
32For development, you can use `go run ./cmd/soju` as usual.
33
34To link with the system libsqlite3, set `GOFLAGS="-tags=libsqlite3"`.
35
36## Contributing
37
38Send patches on the [mailing list] or on [GitHub], report bugs on the
39[issue tracker]. Discuss in [#soju on Libera Chat][IRC channel].
40
41## License
42
43AGPLv3, see LICENSE.
44
45Copyright (C) 2020 The soju Contributors
46
47[soju]: https://soju.im
48[Getting started]: doc/getting-started.md
49[Man page]: https://soju.im/doc/soju.1.html
50[mailing list]: https://lists.sr.ht/~emersion/soju-dev
51[GitHub]: https://github.com/emersion/soju
52[issue tracker]: https://todo.sr.ht/~emersion/soju
53[IRC channel]: ircs://irc.libera.chat/#soju
Note: See TracBrowser for help on using the repository browser.