From b1c8f8d41493b881a8226faa8fbf1ecc2cc3e1b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Melan=C3=A7on?= Date: Mon, 24 May 2021 22:04:39 -0400 Subject: [PATCH] Add documentation for easier program initialization --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index bc4dcf1..701bef6 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,22 @@ python pomodoroprompt.py See the `logs/` folder for daily, one-pomodoro-at-a-time time logs. +### For more convenient command prompt: + +Create file ``~/.local/bin/pomodoroprompt` with contents: + +```bash +#!/bin/bash + +# Helper to call our pomodoro script. We actually skip the & so we can end it +# with ctrl+c + +python ~/Projects/agaric/python/pomodoroprompt/pomodoroprompt.py +``` + +Now you can start it with `pomodoroprompt` on the command line from any directory. + + ## Desired improvements Too many to write down. Suggest your own: