irssi/README.md
Benjamin Denhartog df5132394f
rephrase documentation to be abstract to any given network
IRSSI is an IRC client and should not advertise nor be beholden to any
particular IRC network. This patch is inspired by both of the following
commits, and aims to remove references to any particular network in the
documentation, in an effort to avoid potential conflict amongst team and
community members:

- a4486c236a
- 1ba48840a1

Based on a (as of this writing) draft blog post [0], and the discussion
that has occurred regarding the blog post, it doesn't appear as if the
IRSSI development team is interested in being transparent about the
reasoning behind its aversion to removing the Freenode network,
specifically related to the comments about "potential legal
consequences". By removing references to any given network in the
documentation, this project moves forward without taking a political
stance, but in a way that avoids recommending any given network to
users.

[0]: https://github.com/irssi/irssi.github.io/pull/79
2021-05-27 09:39:41 -06:00

74 lines
2.4 KiB
Markdown

# [Irssi](https://irssi.org/)
![Build Status](https://github.com/irssi/irssi/workflows/Check%20Irssi/badge.svg?branch=master)
Irssi is a modular chat client that is most commonly known for its
text mode user interface, but 80% of the code isn't text mode
specific. Irssi comes with IRC support built in, and there are
third party [ICB](https://github.com/jperkin/irssi-icb),
[SILC](http://www.silcnet.org/),
[XMPP](http://cybione.org/~irssi-xmpp/) (Jabber),
[PSYC](http://about.psyc.eu/Irssyc) and
[Quassel](https://github.com/phhusson/quassel-irssi) protocol modules
available.
![irssi](https://user-images.githubusercontent.com/5665186/32180643-cf127f60-bd92-11e7-8aa2-882313ce1d8e.png)
## [Download information](https://irssi.org/download/)
#### Development source installation
[Ninja](https://ninja-build.org/) 1.5 and [Meson](https://mesonbuild.com/) 0.49
```
git clone https://github.com/irssi/irssi
cd irssi
meson Build
ninja -C Build && sudo ninja -C Build install
```
#### Release source installation
* Download [release](https://github.com/irssi/irssi/releases)
* [Verify](https://irssi.org/download/#release-sources) signature
```
tar xJf irssi-*.tar.xz
cd irssi-*
./configure
make && sudo make install
```
### Requirements
- [glib-2.32](https://wiki.gnome.org/Projects/GLib) or greater
- [openssl](https://www.openssl.org/)
- [perl-5.6](https://www.perl.org/) or greater (for perl support)
- terminfo or ncurses (for text frontend)
#### See the [INSTALL](INSTALL) file for details
## [Documentation](https://irssi.org/documentation/)
* [Frequently Asked Questions](https://irssi.org/documentation/faq)
* [Startup How-To](https://irssi.org/documentation/startup)
* Check the built-in `/HELP`, it has all the details on command syntax
## [Themes](https://irssi-import.github.io/themes/)
## [Scripts](https://scripts.irssi.org/)
## [Modules](https://irssi.org/modules/)
## [Security information](https://irssi.org/security/)
Please report security issues to staff@irssi.org. Thanks!
## [Bugs](https://github.com/irssi/irssi/issues) / Suggestions / [Contributing](https://irssi.org/development/)
Check the GitHub issues if it is already listed in there; if not, open
an issue on GitHub or send a mail to [staff@irssi.org](mailto:staff@irssi.org).
Irssi is always looking for developers. Feel free to submit patches through
GitHub pull requests.
You can also contact the Irssi developers on [one of our official channels](https://irssi.org/support/irc/).