https://github.com/foxbunny/microjournal

Personal desktop microjournaling from command line
https://github.com/foxbunny/microjournal

Last synced: 28 days ago
JSON representation

Personal desktop microjournaling from command line

• Host: GitHub
• URL: https://github.com/foxbunny/microjournal
• Owner: foxbunny
• License: gpl-3.0
• Created: 2011-07-18T10:13:23.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2012-12-24T12:58:17.000Z (almost 12 years ago)
• Last Synced: 2023-03-10T22:13:39.786Z (almost 2 years ago)
• Language: Shell
• Homepage:
• Size: 187 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.mkd
  • License: LICENSE

Awesome Lists containing this project

README

        
# MicroJournal

Bash script for personal desktop microjournaling.

## About microjournaling

Microjournal is a one-liner journal. It's similar to microblogging but meant to

be used privately on your computer.

## About MicroJournal

MicroJournal is a simple script that allows you daily microjournaling. It is 

still in early stages, and it doesn't have a large featureset, but it gets the

job done. It is self-contained and will run on any platform which has Bash

shell, and the Linux-compatible date utility.

## Download

Get MicroJournal directly from GitHub:

 * [latest stable](https://raw.github.com/foxbunny/MicroJournal/8731117b28960dcc22ec54d0a417876a8e5cc115/microj)

 * [development version](https://raw.github.com/foxbunny/MicroJournal/master/microj)

For example:

    curl https://raw.github.com/foxbunny/MicroJournal/master/microj > ~/usr/bin/microj

    chmod +x ~/usr/bin/microj

gets you the latest development version.

## How to use

Copy microj script to any directory you want, and put its path in PATH. Make

sure it is executable.

To add a new entry, simply type:

    microj "Your entry"

If your entry contains spaces, make sure it is quoted.

To use microj interactively, start it by typing ``microj`` with no arguments,

and it will list today's entries, and display a menu below. The menu itself

should be self-explanatory.

## Journal storage

Journal files are `.microj` files stored in your home directory. The main

directory is located at `$HOME/.microj`. Inside that directory, there are two

levels of subdirectories based on journal's date.

For example, Dec 26, 2012 journal would point to a file located at

`$HOME/.microj/2012/12/26.microj`. The files are plain-text, so you can edit

them by hand if you want to correct something.

Keep in mind that journal entries must be on one line. If you edit a file,

be sure to keep it that way or else things _will_ break.

## Changelog

`NEWS.mkd` contains the project changelog.

## License

This software is released under GNU GPL v3. You can see the full text of the

license [on the GNU website](http://www.gnu.org/licenses/gpl-3.0.txt), or 

in the LICENSE file.