update readme
This commit is contained in:
parent
b936d92346
commit
bfd0de4798
1 changed files with 22 additions and 71 deletions
93
README.md
93
README.md
|
|
@ -1,85 +1,36 @@
|
||||||
|
```
|
||||||
|
██████╗██████╗ ██╗ ██╗███╗ ██╗ ██████╗██╗ ██╗██████╗ █████╗ ███╗ ██╗ ██████╗
|
||||||
|
██╔════╝██╔══██╗██║ ██║████╗ ██║██╔════╝██║ ██║██╔══██╗██╔══██╗████╗ ██║██╔════╝
|
||||||
|
██║ ██████╔╝██║ ██║██╔██╗ ██║██║ ███████║██████╔╝███████║██╔██╗ ██║██║ ███╗
|
||||||
|
██║ ██╔══██╗██║ ██║██║╚██╗██║██║ ██╔══██║██╔══██╗██╔══██║██║╚██╗██║██║ ██║
|
||||||
|
╚██████╗██║ ██║╚██████╔╝██║ ╚████║╚██████╗██║ ██║██████╔╝██║ ██║██║ ╚████║╚██████╔╝
|
||||||
|
╚═════╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝ ╚═════╝
|
||||||
|
#! scripts
|
||||||
|
```
|
||||||
|
|
||||||
# Crunchbang
|
# Crunchbang
|
||||||
|
|
||||||
A collection of utility scripts for macOS system management and automation.
|
A personal collection of helper scripts for macOS and Linux server administration.
|
||||||
|
|
||||||
## Scripts
|
## Scripts
|
||||||
|
|
||||||
### `dock.sh`
|
| Script | Platform | Description |
|
||||||
Manages macOS Dock settings.
|
|---|---|---|
|
||||||
|
| `dock.sh` | macOS | Manage Dock settings (check tile size, reset to defaults) |
|
||||||
```bash
|
| `movefiles.sh` | macOS | Move files matching a search word between directories |
|
||||||
./scripts/dock.sh [check|reset]
|
| `toggle-metal-hud.sh` | macOS | Toggle the Metal GPU performance HUD on/off |
|
||||||
```
|
|
||||||
- `check` - Show current Dock tile size
|
|
||||||
- `reset` - Reset Dock to default settings
|
|
||||||
|
|
||||||
### `movefiles.sh`
|
|
||||||
Moves files from one location to another based on a search word in the filename.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./scripts/movefiles.sh [options] <search_word> <source_directory> <destination_directory>
|
|
||||||
```
|
|
||||||
Options:
|
|
||||||
- `-v, --verbose` - Show detailed output
|
|
||||||
- `-p, --include-part` - Include files ending in .part (excluded by default)
|
|
||||||
- `-h, --help` - Show help message
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```bash
|
|
||||||
./scripts/movefiles.sh -v "search-word" ~/Downloads ~/Documents
|
|
||||||
```
|
|
||||||
|
|
||||||
Features:
|
|
||||||
- Searches for files containing the specified word in their filename (case-insensitive)
|
|
||||||
- Excludes .part files and macOS resource fork files by default
|
|
||||||
- Creates destination directory if it doesn't exist
|
|
||||||
- Shows preview of files to be moved before proceeding
|
|
||||||
- Asks for confirmation before moving files
|
|
||||||
- Reports number of files moved after completion
|
|
||||||
|
|
||||||
### `toggle-metal-hud.sh`
|
|
||||||
Toggles the Metal HUD (Heads-Up Display) for macOS Metal applications.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./scripts/toggle-metal-hud.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Features:
|
|
||||||
- Toggles Metal HUD on/off with a single command
|
|
||||||
- Shows current status in the terminal
|
|
||||||
- Useful for debugging Metal applications and monitoring GPU performance
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
1. Clone this repository:
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/yourusername/crunchbang.git
|
|
||||||
cd crunchbang
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Make the scripts executable:
|
|
||||||
```bash
|
|
||||||
chmod +x scripts/*.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
All scripts are located in the `scripts` directory. Each script has built-in help that can be accessed by running it without arguments.
|
Scripts live in the `scripts/` directory. Run any script without arguments for usage info.
|
||||||
|
|
||||||
Example:
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/dock.sh
|
git clone https://github.com/yourusername/crunchbang.git
|
||||||
|
cd crunchbang
|
||||||
|
chmod +x scripts/*.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- macOS
|
- macOS or Linux
|
||||||
- Bash or compatible shell
|
- Bash
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT License - feel free to use and modify these scripts as needed.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Feel free to submit issues and enhancement requests!
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue