source: code/trunk/README.md@ 795

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