From 0f4b077a1cf730c1183beafb27f7da2a164184df Mon Sep 17 00:00:00 2001 From: optimidev Date: Mon, 20 Oct 2025 20:24:00 +0200 Subject: [PATCH] README.md aktualisiert --- README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 83 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 079f0b6..463e982 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,84 @@ -# pirc +# PIRC — Python IRC Client -A minimal Python IRC Client \ No newline at end of file +**PIRC** (Python IRC Client) is a lightweight, modern IRC client built with Python and PySide6. It’s designed for simplicity, usability, and modularity, making it easy to connect to multiple IRC servers with a clean, polished GUI. + +## Features + +- **Clean GUI with sidebar** + - Displays users with icons + - Admins at the top of user list +- **Favorites system** + - Save favorite servers and channels for quick access +- **System messages with timestamps** + - Join/part messages, topics, and important server messages + - Handshake messages filtered out for clean chat +- **Multiple accounts & servers** + - Add unlimited servers and accounts directly from the app +- **Easy packaging** + - Ready for AUR packaging or local installation + +## Installation + +### Requirements + +- Python 3.10+ +- PySide6 (`pip install PySide6`) + +### Run Locally + +1. Clone the repository: + +```bash +git clone https://git.optimihost.com/optimidev/pirc.git +cd PIRC +```` + +2. Install dependencies: + +```bash +pip install PySide6 +``` + +3. Run the client: + +```bash +python pirc.py +``` + +### Optional: AUR Installation (Arch Linux) + +If you’re using Arch Linux, you can build and install PIRC from the AUR: + +```bash +git clone https://aur.archlinux.org/pirc.git +cd pirc +makepkg -si +``` + +--- + +## Usage + +1. On first launch, set your **username** in the setup wizard. +2. Add favorite servers and channels or skip this step. +3. Click **Add Server (+)** to connect to new IRC servers. +4. Select channels and chat with other users. +5. Admins are displayed at the top of the user list. +6. Normal users appear below with a regular icon. + + +--- + +## License + +This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details. + +--- + +## Contributing + +Contributions are welcome! Feel free to submit issues or pull requests on git.optimihost.com + +--- + +```