diff options
| author | St33v <st33v@woodenspoon.net> | 2013-05-15 21:06:07 +1100 |
|---|---|---|
| committer | St33v <st33v@woodenspoon.net> | 2013-05-15 21:06:07 +1100 |
| commit | 6e0f32a0d6331d56feaaa758db9c08ecfb5d72ed (patch) | |
| tree | 383788f2ea1ce911370841466f1af67a58e7d8a0 /README.md | |
| parent | 370368423c85571ee1279e49c1aacd1196780769 (diff) | |
Update README.md
Outlined the project.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -2,3 +2,37 @@ palSort ======= Sort pal event files, grouping by once-only events & repeating events. + +Introduction: +------------ + +pal is a command line calendar app for linux that displays a mini calendar (for the next few weeks) and +marks days that have events associated with them. + +Events are recorded in one or more plain text files with a .pal extension. These files can be edited +manually or using interactive mode in pal. + +Problem: +------- +Events added in pal are appended to the bottom of the event file. After a while it becomes hard to find events +when manually editing the .pal file. Furthermore, recuring events and once-only events become jumbled. The time +codes make simple line sorting impractical. + + +Solution: +-------- + +A script to group events into recurring and once only, sorting once only events +by date, with a marker (such as an empty line or a comment) to distinguish between past and future events. + +Implementation: +-------------- + +Either shell script or perl. + +Notes +----- +This is my first github (and git) repo, so tackling a fairly easy problem seems like a good way to ease into git[hub]. + +I am also quite rusty in perl and an almost n00b on shell scripting. + |
