Skip to content

almnza/project-log

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

This repository was inspired by a comment to a post on https://news.ycombinator.com/.

In the cited comment, a user shared a template they use for documenting their work on project. I have created a shell script that automatically generates a new template and prints it standard output.

Usage

To create a new log from the template, use:
project-log 'title'

The command prints to standard output. Use pipes to save to a file:
project-log 'title' > logfile.txt

Setup

  1. Create a link for the file so it is accessible without needing to specify its full path:
    touch /usr/local/bin/project-log && ln -s project-log.sh /usr/local/bin/project-log
  2. Make the link executable:
    chmod u+x /usr/local/bin/project-log

About

Generate a template for a project log journal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages