parch-zsh-config/README.md

Parch Linux Zsh Configuration

A comprehensive Zsh configuration package for Parch Linux, featuring productivity-enhancing aliases and fun interactive functions.

🌟 Features

Included Aliases

• File Management: Smart shortcuts for navigating and managing files
• Package Management: Streamlined pacman and paru commands
• Git Operations: Quick git command shortcuts
• Network Utilities: Easy network management and monitoring
• System Management: System monitoring and maintenance shortcuts
• Quality of Life: Various utility commands for better productivity

Interactive Functions

• typewriter.zsh: Text animation effect
• weather.zsh: Terminal-based weather information
• fireworks.zsh: ASCII fireworks animation
• coin.zsh: Coin flip simulator
• dice.zsh: Dice rolling simulator
• extract.zsh: Universal archive extractor
• genpass.zsh: Password generator

📁 Project Structure

.
├── build.sh           # Build script
├── parch.install      # Installation hooks
├── PKGBUILD          # Package build instructions
├── README.md         # This file
└── rootfs            # Root filesystem structure
    └── usr
        └── share
            └── parchlinux
                └── zsh
                    ├── alias
                    │   └── alias         # Alias definitions
                    ├── functions         # Interactive functions
                    │   ├── coin.zsh
                    │   ├── dice.zsh
                    │   ├── extract.zsh
                    │   ├── fireworks.zsh
                    │   ├── genpass.zsh
                    │   ├── typewriter.zsh
                    │   └── weather.zsh
                    ├── install.txt       # Installation instructions
                    └── zshrc-example     # Example Zsh configuration

🚀 Installation

Via Package Manager

sudo pacman -S parch-zsh-config

Manual Installation

1. Clone the repository:

git clone https://git.parchlinux.com/config/parch-zsh-config

2. Build and install:

cd parch-zsh-config
./build.sh
sudo pacman -U parch-zsh-config-*.pkg.tar.zst

🛠️ Configuration

1. Copy the example configuration:

cp /usr/share/parchlinux/zsh/zshrc-example ~/.zshrc

2. Source the configuration:

source ~/.zshrc

📖 Usage

Common Aliases

File Management

• del: Safely move files to trash
• .., ..., ....: Navigate up directories
• back: Return to previous directory
• la: List all files with details
• lsd: List only directories

Package Management

• update: Update system packages
• search: Search packages
• cleanup: Remove orphaned packages and clean cache

Git Operations

• gs: Git status
• ga: Git add
• gc: Git commit
• gp: Git pull
• gpu: Git push

System Management

• dfh: Disk usage in human-readable format
• meminfo: Memory information
• cpuinfo: CPU information
• journal: View system logs

Interactive Functions

• typewriter "text": Display text with typewriter effect
• weather [city]: Show weather information
• fireworks: Display ASCII fireworks
• roll: Roll dice
• flip: Flip a coin
• genpass [length]: Generate secure password
• extract <file>: Extract any archive format

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the GPL-3 License - see the LICENSE file for details.

🙏 Acknowledgments

• Parch Linux Team
• Zsh Community
• All contributors who have helped shape this configuration

🐛 Bug Reports

Please report bugs and issues on the Gitlab issues page.

📞 Contact

• Website: https://parchlinux.com
• Gitlab: https://git.parchlinux.com/config/parch-zsh-config