From 438bac4c8d6bb0a50e11fc6d0cb6ee816e8f32c2 Mon Sep 17 00:00:00 2001 From: steering7253 Date: Wed, 10 Sep 2025 13:23:39 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=E2=9C=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 88 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 47 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index bfe521d3..024ae84a 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,80 @@ -# [Irssi](https://irssi.org) +# The Ultimate IRC Experience: Irssi ✨ πŸš€ -![Build Status](https://github.com/irssi/irssi/workflows/Check%20Irssi/badge.svg?branch=master) +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. It’s the perfect tool for developers, sysadmins, and anyone who prefers the power and efficiency of the command line. πŸ’» -Irssi is a modular text mode chat client. 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) +## Getting Started πŸš€ -## [Download information](https://irssi.org/download/) +### Installation πŸ› οΈ -#### Development source installation +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. πŸ“¦ -[Ninja](https://ninja-build.org/) 1.8 and [Meson](https://mesonbuild.com/) 0.53 +**Development Source Installation** -``` +To get the absolute latest features and fixes, clone the Git repository and build the project using **Ninja** and **Meson**. πŸ‘¨β€πŸ’» + +```sh git clone https://github.com/irssi/irssi cd irssi meson Build ninja -C Build && sudo ninja -C Build install ``` -#### Release source installation +**Release Source Installation** -* Download [release](https://github.com/irssi/irssi/releases) -* Verify signature -``` +For a stable, tested version, download the official release from GitHub. Be sure to verify the signature for a secure installation. πŸ” + +```sh tar xJf irssi-*.tar.xz cd irssi-* meson Build ninja -C Build && sudo ninja -C Build install ``` -### Requirements +**System Requirements** -- [glib-2.32](https://wiki.gnome.org/Projects/GLib) or greater -- [openssl](https://www.openssl.org/) -- [perl-5.8](https://www.perl.org/) or greater (for perl support) -- terminfo or ncurses (for text frontend) +Before you start, make sure you have the following dependencies: πŸ‘‡ -#### See the [INSTALL](INSTALL) file for details + * **glib-2.32** or greater + * **openssl** πŸ›‘οΈ + * **perl-5.8** or greater (for Perl support) 🧩 + * **terminfo** or **ncurses** (for the text frontend) πŸ–₯️ -## [Documentation](https://irssi.org/documentation/) +For more detailed instructions, check the **INSTALL** file. πŸ“„ -* [New users guide](https://irssi.org/New-users/) -* [Questions and Answers](https://irssi.org/documentation/qna/) -* Check the built-in `/HELP`, it has all the details on command syntax +----- -## [Themes](https://irssi-import.github.io/themes/) +## Dive into the Details πŸ“– -## [Scripts](https://scripts.irssi.org/) +### Documentation πŸ“š -## [Modules](https://irssi.org/modules/) +Whether you're a new user or a seasoned pro, the Irssi documentation is your best friend. 🀝 -## [Security information](https://irssi.org/security/) + * **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. -Please report security issues to staff@irssi.org. Thanks! +### Customization ✨ -## [Bugs](https://github.com/irssi/irssi/issues) / Suggestions / Contributing +Make Irssi your own with a vibrant community of themes, scripts, and modules. 🎨 -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). + * **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. -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. +## 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. πŸ™