irssi/README.md

80 lines
3.2 KiB
Markdown
Raw Normal View History

2025-09-10 13:23:39 -06:00
# The Ultimate IRC Experience: Irssi ✨ 🚀
2025-09-10 13:23:39 -06:00
Irssi is the modular, **text-mode chat client** that puts you in control. 🧑‍💻 It comes with built-in **IRC** support, and its extensible design lets you connect to other chat networks, including **ICB** 💬, **SILC** 🔒, **XMPP** (Jabber) 🕊️, **PSYC** 🧠, and **Quassel** 🏘️, via third-party modules. Its the perfect tool for developers, sysadmins, and anyone who prefers the power and efficiency of the command line. 💻
2014-06-15 17:32:17 +02:00
2025-09-10 13:23:39 -06:00
-----
2025-09-10 13:23:39 -06:00
## Getting Started 🚀
2025-09-10 13:23:39 -06:00
### Installation 🛠️
2025-09-10 13:23:39 -06:00
There are a few ways to get Irssi up and running. If you're looking to contribute to development, you'll want the latest source. For a stable release, you can download a pre-packaged tarball. 📦
2025-09-10 13:23:39 -06:00
**Development Source Installation**
2019-07-17 11:52:20 +00:00
2025-09-10 13:23:39 -06:00
To get the absolute latest features and fixes, clone the Git repository and build the project using **Ninja** and **Meson**. 👨‍💻
```sh
2022-06-06 21:47:19 +02:00
git clone https://github.com/irssi/irssi
2017-10-30 16:54:32 +01:00
cd irssi
2019-07-16 14:23:12 +00:00
meson Build
ninja -C Build && sudo ninja -C Build install
2017-10-30 16:54:32 +01:00
```
2025-09-10 13:23:39 -06:00
**Release Source Installation**
2025-09-10 13:23:39 -06:00
For a stable, tested version, download the official release from GitHub. Be sure to verify the signature for a secure installation. 🔐
```sh
2017-10-30 16:54:32 +01:00
tar xJf irssi-*.tar.xz
cd irssi-*
2021-09-01 23:37:11 +02:00
meson Build
ninja -C Build && sudo ninja -C Build install
2017-10-30 16:54:32 +01:00
```
2025-09-10 13:23:39 -06:00
**System Requirements**
2025-09-10 13:23:39 -06:00
Before you start, make sure you have the following dependencies: 👇
2025-09-10 13:23:39 -06:00
* **glib-2.32** or greater
* **openssl** 🛡️
* **perl-5.8** or greater (for Perl support) 🧩
* **terminfo** or **ncurses** (for the text frontend) 🖥️
2025-09-10 13:23:39 -06:00
For more detailed instructions, check the **INSTALL** file. 📄
2025-09-10 13:23:39 -06:00
-----
2025-09-10 13:23:39 -06:00
## Dive into the Details 📖
2025-09-10 13:23:39 -06:00
### Documentation 📚
2025-09-10 13:23:39 -06:00
Whether you're a new user or a seasoned pro, the Irssi documentation is your best friend. 🤝
2025-09-10 13:23:39 -06:00
* **New User's Guide** 👶: A gentle introduction to the basics.
* **Questions and Answers** ❓: Find quick solutions to common issues.
* **Built-in Help** `/HELP` 💡: Use the `/HELP` command directly in Irssi for detailed information on every command and syntax.
2025-09-10 13:23:39 -06:00
### Customization ✨
2025-09-10 13:23:39 -06:00
Make Irssi your own with a vibrant community of themes, scripts, and modules. 🎨
2017-10-30 16:54:32 +01:00
2025-09-10 13:23:39 -06:00
* **Themes** 🌈: Customize the look and feel of your chat client.
* **Scripts** ✍️: Extend functionality with user-created scripts.
* **Modules** 🏗️: Add support for new protocols or features.
2017-10-30 16:54:32 +01:00
2025-09-10 13:23:39 -06:00
-----
2017-10-30 16:54:32 +01:00
2025-09-10 13:23:39 -06:00
## Community & Support 🫂
### Get Involved 👋
Irssi is an **open-source project** and thrives on community contributions. We're always looking for new developers\! 🌟
* **Bug Reports & Suggestions** 🐞💡: Have a problem or a great idea? Check the [GitHub issues](https://github.com/irssi/irssi/issues) to see if it's already been reported, or open a new one. You can also email us at **staff@irssi.org**. 📧
* **Contributions** 💖: Feel free to submit patches via **GitHub pull requests**.
* **Chat with us\!** 🗣️: You can find the developers and other users in **\#irssi** on irc.libera.chat. 💬
### Security 🛡️
We take security seriously. If you discover a security issue, please report it privately to **staff@irssi.org**. Your help in keeping Irssi secure is greatly appreciated. 🙏