NAME

Standup::Diary - Manage a simple journal in Markdown files

SYNOPSIS

carton exec perl ./script/diary.pl --data-dir /home/smonff/diary/ --project-name SeriousWork

DESCRIPTION

This module helps you to keep a directory of organized daily notes.

It provides a way to customize the notes template.

FUN FACTS

I use it daily at work since 2021 to prepare and read notes for daily standups.

It's also my pet project for Perl's Corinna implementation of the core OOP features. Diary.pm use Object::Pad, though, that is the test bed for the core features.

INSTALLATION

# Install a Perl module manager
apt install carton

git clone git@codeberg.org:smonff/Diary.git

cd Diary

# Install CPAN dependencies
carton install

HOW I USE IT?

I set an alias in my .bashrc. Should also work in your own-favorite-shell:

alias diary="cd ~/project/diary/ && carton exec perl ./script/diary.pl --data-dir /home/smonff/diary --project-name SeriousWork && cd -";

Each morning, before my work standup, I run diary. It create a Markdown file in the specified --project-name directory. I then edit my thoughts with an editor.

METHODS

init_daily_data_path

Helper that initialize $daily_data_path with a Path::Tiny instance for the current day diary entry.

# foo/2022/03 (Path::Tiny)
$self->init_daily_data_path($self->build_path)

render()

write()

LICENSE

Copyright 2022-2024 Sebastien Feugère

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.

See perlartistic.

AUTHOR

Sébastien Feugère - seb@feugere.net

SEE ALSO

StandupGenerator

On the CPAN, this is pretty much all what I found. I like the spirit of this one.

Almanac

A similar effort written in Bash.