soju/README.md

# [soju]

[![builds.sr.ht status](https://builds.sr.ht/~emersion/soju/commits/master.svg)](https://builds.sr.ht/~emersion/soju/commits/master?)

soju is a user-friendly IRC bouncer. soju connects to upstream IRC servers on
behalf of the user to provide extra functionality. soju supports many features
such as multiple users, numerous [IRCv3] extensions, chat history playback and
detached channels. It is well-suited for both small and large deployments.

## Usage

* [Getting started]
* [Man page]

## Building and installing

Dependencies:

- Go
- BSD or GNU make
- a C89 compiler (for SQLite)
- scdoc (optional, for man pages)

For end users, a `Makefile` is provided:

    make
    sudo make install

For development, you can use `go run ./cmd/soju` as usual.

To link with the system libsqlite3, set `GOFLAGS="-tags=libsqlite3"`.

## Contributing

Send patches on the [mailing list] or on [GitHub], report bugs on the
[issue tracker]. Discuss in [#soju on Libera Chat][IRC channel].

## License

AGPLv3, see LICENSE.

Copyright (C) 2020 The soju Contributors

[soju]: https://soju.im
[Getting started]: doc/getting-started.md
[Man page]: https://soju.im/doc/soju.1.html
[mailing list]: https://lists.sr.ht/~emersion/soju-dev
[GitHub]: https://github.com/emersion/soju
[issue tracker]: https://todo.sr.ht/~emersion/soju
[IRC channel]: ircs://irc.libera.chat/#soju
[IRCv3]: https://ircv3.net/
readme: add link to website 2020-06-10 21:00:50 +00:00			`# [soju]`
Add LICENSE and README.md 2020-02-04 09:50:28 +00:00
readme: restrict CI badge to master branch 2022-04-28 12:12:31 +00:00			`[![builds.sr.ht status](https://builds.sr.ht/~emersion/soju/commits/master.svg)](https://builds.sr.ht/~emersion/soju/commits/master?)`
readme: add CI badge 2020-05-01 19:58:29 +00:00
readme: copy over updated description from website 2022-06-27 12:30:28 +00:00			`soju is a user-friendly IRC bouncer. soju connects to upstream IRC servers on`
			`behalf of the user to provide extra functionality. soju supports many features`
			`such as multiple users, numerous [IRCv3] extensions, chat history playback and`
			`detached channels. It is well-suited for both small and large deployments.`
readme: add some high-level goals, add contributing links 2020-02-17 11:19:27 +00:00
readme: add instructions to initialize database 2020-03-04 17:27:33 +00:00			`## Usage`

readme: move quickstart to dedicated doc page 2021-05-21 22:01:06 +00:00			`* [Getting started]`
			`* [Man page]`
readme: expand usage 2020-06-12 12:06:15 +00:00
readme: mention Makefile, assume soju is installed system-wide 2021-04-19 14:35:18 +00:00			`## Building and installing`
readme: expand usage 2020-06-12 12:06:15 +00:00
readme: list dependencies 2021-06-24 19:32:54 +00:00			`Dependencies:`

			`- Go`
makefile: switch to BSD/GNU make Let's stop using POSIX make, it's too much of a pain. 2022-02-08 15:10:19 +00:00			`- BSD or GNU make`
Add a C compiler to the list of dependencies It's needed to build sqlite3. 2021-06-30 08:03:27 +00:00			`- a C89 compiler (for SQLite)`
readme: list dependencies 2021-06-24 19:32:54 +00:00			`- scdoc (optional, for man pages)`

readme: mention Makefile, assume soju is installed system-wide 2021-04-19 14:35:18 +00:00			For end users, a `Makefile` is provided:

			`make`
			`sudo make install`

			For development, you can use `go run ./cmd/soju` as usual.
readme: add ref to man page, add link to GitHub repo 2020-03-19 13:33:49 +00:00
makefile: switch to BSD/GNU make Let's stop using POSIX make, it's too much of a pain. 2022-02-08 15:10:19 +00:00			To link with the system libsqlite3, set `GOFLAGS="-tags=libsqlite3"`.
readme: add note to use system libsqlite3 2021-09-21 09:44:08 +00:00
readme: add some high-level goals, add contributing links 2020-02-17 11:19:27 +00:00			`## Contributing`

readme: add ref to man page, add link to GitHub repo 2020-03-19 13:33:49 +00:00			`Send patches on the [mailing list] or on [GitHub], report bugs on the`
readme: add link to IRC channel 2021-05-21 22:04:22 +00:00			`[issue tracker]. Discuss in [#soju on Libera Chat][IRC channel].`
Add LICENSE and README.md 2020-02-04 09:50:28 +00:00
			`## License`

Switch license to AGPLv3 2020-02-07 16:41:51 +00:00			`AGPLv3, see LICENSE.`

readme: extend copyright notice to all contributors soju now has multiple contributors. Even if they weren't explicitly listed as copyright holders, they still retain copyright ownership for their contributions. Make this clear. See [1]. [1]: https://www.linuxfoundation.org/blog/2020/01/copyright-notices-in-open-source-software-projects/ 2020-06-12 12:37:43 +00:00			`Copyright (C) 2020 The soju Contributors`
readme: add some high-level goals, add contributing links 2020-02-17 11:19:27 +00:00
readme: add link to website 2020-06-10 21:00:50 +00:00			`[soju]: https://soju.im`
readme: move quickstart to dedicated doc page 2021-05-21 22:01:06 +00:00			`[Getting started]: doc/getting-started.md`
readme: link to rendered man page 2021-05-23 19:41:01 +00:00			`[Man page]: https://soju.im/doc/soju.1.html`
readme: update mailing list link 2020-07-24 07:49:54 +00:00			`[mailing list]: https://lists.sr.ht/~emersion/soju-dev`
readme: add ref to man page, add link to GitHub repo 2020-03-19 13:33:49 +00:00			`[GitHub]: https://github.com/emersion/soju`
Rename project to soju 2020-03-13 17:13:03 +00:00			`[issue tracker]: https://todo.sr.ht/~emersion/soju`
readme: add link to IRC channel 2021-05-21 22:04:22 +00:00			`[IRC channel]: ircs://irc.libera.chat/#soju`
readme: copy over updated description from website 2022-06-27 12:30:28 +00:00			`[IRCv3]: https://ircv3.net/`