irssi/README.md

# Neırssi

![Build Status](https://github.com/ailin-nemui/irssi/workflows/Check%20Irssi/badge.svg?branch=master)

Neırssi is a modular text mode chat client mostly compatible with
[Irssi](https://irssi.org). It 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://ailin-nemui.github.io/irssi/Getting.html)

#### Development source installation

[Ninja](https://ninja-build.org/) 1.5 and [Meson](https://mesonbuild.com/) 0.49

```
git clone https://github.com/ailin-nemui/irssi
cd irssi
meson Build
ninja -C Build && sudo ninja -C Build install
```

#### Release source installation

* Download [release](https://github.com/ailin-nemui/irssi/releases)
* Verify signature
```
tar xJf irssi-*.tar.xz
cd irssi-*
meson Build
ninja -C Build && sudo ninja -C Build 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

* [New users guide](https://ailin-nemui.github.io/irssi/New-users.html)
* Check the built-in `/HELP`, it has all the details on command syntax
* Other random Irssi documentation on https://irssi.org/documentation/

## [Themes](https://irssi-import.github.io/themes/)

## [Scripts](https://scripts.irssi.org/)

## [Modules](https://ailin-nemui.github.io/irssi/Modules.html)

## [Security information](https://irssi.org/security/)

Please report security issues to staff@irssi.org. Thanks!

## [Bugs](https://github.com/irssi/irssi/issues) / Suggestions / Contributing

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 in
[#irssi](https://irssi.org/support/irc/) on irc.libera.chat.
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								# Neırssi
-												Cleanup README.md

This patch restructures and cleans up README.md slightly to make it a
more structured for Github's README.md repository view.

											
										
										
											2014-06-12 06:15:31 -04:00
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								![Build Status](https://github.com/ailin-nemui/irssi/workflows/Check%20Irssi/badge.svg?branch=master)
-												Add build status to README.md

											
										
										
											2014-06-15 11:32:17 -04:00
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								Neırssi is a modular text mode chat client mostly compatible with
 								[Irssi](https://irssi.org). It comes with IRC support built in, and
 								there are third party [ICB](https://github.com/jperkin/irssi-icb),
-												point out more modules in README

											
										
										
											2014-06-29 20:25:32 -04:00
+								[SILC](http://www.silcnet.org/),
 								[XMPP](http://cybione.org/~irssi-xmpp/) (Jabber),
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								[PSYC](http://about.psyc.eu/Irssyc) and
-												point out more modules in README

											
										
										
											2014-06-29 20:25:32 -04:00
+								[Quassel](https://github.com/phhusson/quassel-irssi) protocol modules
 								available.
-												Initial revision


git-svn-id: http://svn.irssi.org/repos/irssi/trunk@3 dbcabf3a-b0e7-0310-adc4-f8d773084564

											
										
										
											1999-09-03 10:27:29 -04:00
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								![irssi](https://user-images.githubusercontent.com/5665186/32180643-cf127f60-bd92-11e7-8aa2-882313ce1d8e.png)
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								## [Download information](https://ailin-nemui.github.io/irssi/Getting.html)
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
 								#### Development source installation
-												Link to Ninja site and use HTTPS for Meson site

											
										
										
											2019-07-20 17:29:23 -04:00
+								[Ninja](https://ninja-build.org/) 1.5 and [Meson](https://mesonbuild.com/) 0.49
-												Add Meson ver requirement to readme
											
										
										
											2019-07-17 07:52:20 -04:00
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								```
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								git clone https://github.com/ailin-nemui/irssi
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								cd irssi
-												Show meson commands in README
											
										
										
											2019-07-16 10:23:12 -04:00
+								meson Build
 								ninja -C Build && sudo ninja -C Build install
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								```
 								#### Release source installation
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								* Download [release](https://github.com/ailin-nemui/irssi/releases)
 								* Verify signature
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								```
 								tar xJf irssi-*.tar.xz
 								cd irssi-*
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								meson Build
 								ninja -C Build && sudo ninja -C Build install
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								```
 								### Requirements
-												raise glib version requirement to 2.32 for g_hash_table_contains

											
										
										
											2021-01-28 15:25:53 -05:00
+								- [glib-2.32](https://wiki.gnome.org/Projects/GLib) or greater
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								- [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
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								## Documentation
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								* [New users guide](https://ailin-nemui.github.io/irssi/New-users.html)
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
+								* Check the built-in `/HELP`, it has all the details on command syntax
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								* Other random Irssi documentation on https://irssi.org/documentation/
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
 								## [Themes](https://irssi-import.github.io/themes/)
-												Update Irssi website URLs

											
										
										
											2018-01-16 10:23:54 -05:00
+								## [Scripts](https://scripts.irssi.org/)
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								## [Modules](https://ailin-nemui.github.io/irssi/Modules.html)
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
 								## [Security information](https://irssi.org/security/)
 								Please report security issues to staff@irssi.org. Thanks!
-												branding

											
										
										
											2021-09-01 17:37:11 -04:00
+								## [Bugs](https://github.com/irssi/irssi/issues) / Suggestions / Contributing
-												Update README.md
											
										
										
											2017-10-30 11:54:32 -04:00
 								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 in
-												update default network

											
										
										
											2021-05-19 15:51:39 -04:00
+								[#irssi](https://irssi.org/support/irc/) on irc.libera.chat.