70 lines
1.9 KiB
Markdown
70 lines
1.9 KiB
Markdown
# crunchbang
|
|
|
|
A collection of useful bash scripts to enhance your command-line experience and automate common tasks.
|
|
|
|
## 🚀 Overview
|
|
|
|
This repository contains a curated set of bash scripts that can help streamline your workflow, automate repetitive tasks, and make your command-line experience more efficient. Each script is well-documented and designed to be easily integrated into your daily routine.
|
|
|
|
## 📦 Installation
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://git.okseby.com/okseby/crunchbang.git
|
|
cd crunchbang
|
|
```
|
|
|
|
2. Make the scripts executable:
|
|
```bash
|
|
chmod +x scripts/*.sh
|
|
```
|
|
|
|
3. (Optional) Add the scripts directory to your PATH:
|
|
```bash
|
|
echo 'export PATH="$PATH:$(pwd)/scripts"' >> ~/.bashrc
|
|
# or for zsh
|
|
echo 'export PATH="$PATH:$(pwd)/scripts"' >> ~/.zshrc
|
|
```
|
|
|
|
## 🛠️ Available Scripts
|
|
|
|
Each script in this collection serves a specific purpose. Here's a brief overview of what's available:
|
|
|
|
- `scripts/`: Directory containing all the bash scripts
|
|
- (Scripts will be listed here as they are added)
|
|
|
|
## 📖 Usage
|
|
|
|
Each script includes its own documentation and usage instructions. You can view the help for any script by running:
|
|
|
|
```bash
|
|
./scripts/script-name.sh --help
|
|
```
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! If you have a useful bash script that you'd like to share:
|
|
|
|
1. Fork the repository
|
|
2. Create a new branch for your feature
|
|
3. Add your script to the `scripts/` directory
|
|
4. Update the README with information about your script
|
|
5. Submit a pull request
|
|
|
|
Please ensure your scripts:
|
|
- Include proper documentation
|
|
- Follow bash best practices
|
|
- Include error handling
|
|
- Are tested thoroughly
|
|
|
|
## 📝 License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## ⭐ Support
|
|
|
|
If you find these scripts useful, please consider giving the repository a star! For issues, feature requests, or questions, please open an issue in the GitLab repository.
|
|
|
|
---
|
|
|
|
Made with ❤️ by [Your Name]
|