Complete README and documentation with full script descriptions

This commit is contained in:
Jeremie Fraeys 2026-02-09 13:59:25 -05:00
parent 291b9019d3
commit b22ea85e9e
No known key found for this signature in database
2 changed files with 22 additions and 12 deletions

View file

@ -16,12 +16,17 @@ Welcome to the .local-bin repository! Find key components below to enhance your
- **[wzp.sh](scripts/wzp.sh):** This script automates the process of starting a new Wezterm project. It allows you to select a project from a predefined list or specify a project name as an argument.
- **[volumizer.sh](scripts/volumizer.sh):** This script manages volume levels on macOS and Linux systems. It limits the volume to a specified maximum when headphones are connected, protecting users' hearing. It integrates notifications to alert users of volume changes and headphone status seamlessly.
- **[fzf_theme.sh](scripts/fzf_theme.sh):** This script configures the `fzf` color theme based on the system's appearance mode (Light or Dark) for both macOS and Linux systems. It automatically detects the system's appearance or can be overridden with a specified mode, adjusting the `fzf` theme colors accordingly.
- **[bootstrap_setup.sh](scripts/bootstrap_setup.sh):**
- **[check_alias.sh](scripts/check_alias.sh):**
- **[most_recent_note.sh](scripts/most_recent_note.sh):**
- **[buildnote.sh](scripts/buildnote.sh):**
- **[kaggle_manager](scripts/kaggle_manager.sh):**
- **[notetaker.sh](scripts/notetaker.sh):**
- **[bootstrap_setup.sh](scripts/bootstrap_setup.sh):** Bootstraps a new development machine by installing essential tools (git, stow, curl), cloning dotfiles repository, and setting up dev scripts. Supports dry-run mode with `--dry-run` flag.
- **[buildnote.sh](scripts/buildnote.sh):** Converts markdown notes to PDF using pandoc with xelatex engine. Uses DejaVu fonts and applies syntax highlighting for code blocks.
- **[most_recent_note.sh](scripts/most_recent_note.sh):** Opens the most recently created PDF note from Google Drive notes folder using zathura PDF viewer.
- **[notetaker.sh](scripts/notetaker.sh):** Creates and opens daily markdown notes with YAML frontmatter in Neovim. Automatically timestamps entries and organizes notes by date.
- **[kaggle_manager.sh](scripts/kaggle_manager.sh):** Manages Kaggle datasets and notebooks. Downloads datasets, fetches notebooks, and submits competition entries using Kaggle API credentials from ~/.kaggle/kaggle.json.
- **[promodoro.sh](scripts/promodoro.sh):** Pomodoro timer script for productivity tracking.
- **[promodoro_menu.sh](scripts/promodoro_menu.sh):** Interactive menu interface for the Pomodoro timer.
- **[setup_crontab.sh](scripts/setup_crontab.sh):** Sets up automated cron jobs for system maintenance and scheduled tasks.
- **[add_ipykernel.sh](scripts/add_ipykernel.sh):** Adds Python virtual environments as Jupyter ipykernel options.
- **[get_app_id.sh](scripts/get_app_id.sh):** Retrieves macOS application bundle identifiers.
- **[setup_macos_dock.sh](scripts/setup_macos_dock.sh):** Configures macOS Dock settings including auto-hide, icon size, and app placement.
## Documentation

View file

@ -26,12 +26,17 @@ Most scripts in this repository support both macOS and Linux:
- [wzp](wzp/Usage.md): This script automates the process of starting a new Wezterm project. It allows you to select a project from a predefined list or specify a project name as an argument.
- [volumizer](volumizer/Usage.md): This script manages volume levels on macOS and Linux systems. It limits the volume to a specified maximum when headphones are connected, protecting users' hearing. It integrates notifications to alert users of volume changes and headphone status seamlessly.
- [fzf_theme](fzf_theme/Usage.md): This script configures the `fzf` color theme based on the system's appearance mode (Light or Dark) for both macOS and Linux systems. Automatically detects GNOME, KDE, and other desktop environments on Linux.
- **[bootstrap_setup.sh](scripts/bootstrap_setup.sh):**
- **[check_alias.sh](scripts/check_alias.sh):**
- **[most_recent_note.sh](scripts/most_recent_note.sh):**
- **[buildnote.sh](scripts/buildnote.sh):**
- **[kaggle_manager](scripts/kaggle_manager.sh):**
- **[notetaker.sh](scripts/notetaker.sh):**
- [bootstrap_setup](bootstrap_setup/Usage.md): Bootstraps a new development machine by installing essential tools (git, stow, curl), cloning dotfiles repository, and setting up dev scripts. Supports dry-run mode with `--dry-run` flag.
- [buildnote](buildnote/Usage.md): Converts markdown notes to PDF using pandoc with xelatex engine. Uses DejaVu fonts and applies syntax highlighting for code blocks.
- [most_recent_note](most_recent_note/Usage.md): Opens the most recently created PDF note from Google Drive notes folder using zathura PDF viewer.
- [notetaker](notetaker/Usage.md): Creates and opens daily markdown notes with YAML frontmatter in Neovim. Automatically timestamps entries and organizes notes by date.
- [kaggle_manager](kaggle_manager/Usage.md): Manages Kaggle datasets and notebooks. Downloads datasets, fetches notebooks, and submits competition entries using Kaggle API credentials.
- [promodoro](promodoro/Usage.md): Pomodoro timer script for productivity tracking.
- [promodoro_menu](promodoro_menu/Usage.md): Interactive menu interface for the Pomodoro timer.
- [setup_crontab](setup_crontab/Usage.md): Sets up automated cron jobs for system maintenance and scheduled tasks.
- [add_ipykernel](add_ipykernel/Usage.md): Adds Python virtual environments as Jupyter ipykernel options.
- [get_app_id](get_app_id/Usage.md): Retrieves macOS application bundle identifiers.
- [setup_macos_dock](setup_macos_dock/Usage.md): Configures macOS Dock settings including auto-hide, icon size, and app placement.
Feel free to use these scripts to simplify tasks and enhance your development workflow.