A lightweight tool to display a local calendar in the terminal
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Cédric Marie 8b5964b463 First functional version of Raindrop 2 weeks ago
src First functional version of Raindrop 2 weeks ago
COPYING First functional version of Raindrop 2 weeks ago
Cargo.toml First functional version of Raindrop 2 weeks ago
README.md First functional version of Raindrop 2 weeks ago

README.md

Raindrop

Raindrop is a lightweight tool to display a local calendar in the terminal.

License

Copyright © 2021 Cédric Marie cedric@hjuvi.fr.eu.org

Raindrop is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Raindrop is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Raindrop. If not, see http://www.gnu.org/licenses/.

Requirements

Raindrop uses Cargo (Rust package manager). In order to build the program from the source code, you have to install cargo package.

Building and installing

You can build and install the program for the current user in its ~/.cargo/bin directory:

$ cargo install --path .

Usage

Create ~/raindrop.txt text file, with events in the following format:

YYYY-MM-DD: Description event 1
YYYY-MM-DD: Description event 2

This file must be edited manually to add or remove events.

Display the calendar in the terminal with:

$ raindrop

For more information, you can print the help:

$ raindrop --help

Support

To report a bug, or suggest an improvement, please send an email to the address mentioned at the beginning of this file.