Files

Paolo Donadeo 9d33272a55 feat: rewrite README in English, update plugin info, and localize scripts

- Rewrite README.md in English with detailed features, installation,
  usage, and configuration instructions
- Update plugin name and repository references to "tmux-remind"
- Change script comments and popup titles from Italian to English
- Standardize less status line in show_calendar.sh to English

2025-12-24 12:53:37 +01:00

1.5 KiB

Raw Blame History

tmux-remind

A tmux plugin that integrates with remind to display reminders and calendar views in tmux popups.

Features

Quick Reminders View: Display today's reminders in a centered popup (60% width/height)
Calendar View: Show a 2-week calendar overview in a full-screen popup (99% width/height)
Uses less for scrollable output with line position indicator

Requirements

remind - A sophisticated calendar and alarm program
tmux 3.2+ (for display-popup support)

Installation

With TPM (Tmux Plugin Manager)

Add to your ~/.tmux.conf:

set -g @plugin 'your-username/tmux-remind'

Reload tmux and press prefix + I to install.

Manual Installation

git clone https://github.com/your-username/tmux-remind ~/.tmux/plugins/tmux-remind

Add to your ~/.tmux.conf:

run-shell ~/.tmux/plugins/tmux-remind/tmux-remind.tmux

Usage

The plugin provides two keybindings:

Keybinding	Action
`prefix + r`	Show today's reminders in a popup
`prefix + c`	Show 2-week calendar in a popup

Both views use less for navigation:

j / k or arrow keys to scroll
q to close the popup
/ to search
g to go to top, G to go to bottom

Configuration

The plugin uses your default remind configuration. Make sure you have your .reminders file set up in your home directory or configure remind accordingly.

License

MIT

1.5 KiB Raw Blame History