okseby/crunchbang
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix README

Browse source
This commit is contained in:
Sebastian Cabrera 2025-03-13 17:03:13 -04:00
parent 98b272f922
commit d19af4033b
1 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -16,29 +16,28 @@ cd crunchbang
2. Make the scripts executable: 2. Make the scripts executable:
```bash ```bash
chmod +x scripts/*.sh chmod +x *.sh
``` ```
3. (Optional) Add the scripts directory to your PATH: 3. (Optional) Add the repository to your PATH:
```bash ```bash
echo 'export PATH="$PATH:$(pwd)/scripts"' >> ~/.bashrc echo 'export PATH="$PATH:$(pwd)"' >> ~/.bashrc
# or for zsh # or for zsh
echo 'export PATH="$PATH:$(pwd)/scripts"' >> ~/.zshrc echo 'export PATH="$PATH:$(pwd)"' >> ~/.zshrc
``` ```
## 🛠️ Available Scripts ## 🛠️ Available Scripts
Each script in this collection serves a specific purpose. Here's a brief overview of what's available: 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)
- (Scripts will be listed here as they are added)
## 📖 Usage ## 📖 Usage
Each script includes its own documentation and usage instructions. You can view the help for any script by running: Each script includes its own documentation and usage instructions. You can view the help for any script by running:
```bash ```bash
./scripts/script-name.sh --help ./script-name.sh --help
``` ```
## 🤝 Contributing ## 🤝 Contributing
@ -47,7 +46,7 @@ Contributions are welcome! If you have a useful bash script that you'd like to s
1. Fork the repository 1. Fork the repository
2. Create a new branch for your feature 2. Create a new branch for your feature
3. Add your script to the `scripts/` directory 3. Add your script to the root directory
4. Update the README with information about your script 4. Update the README with information about your script
5. Submit a pull request 5. Submit a pull request