cleaned up readme
This commit is contained in:
94
README.md
94
README.md
@ -2,51 +2,59 @@
|
||||
|
||||
<img src="https://git.laboratoryb.org/trav/calendarender/raw/branch/master/calendar.jpg" width=556>
|
||||
|
||||
These are 2 scripts I use for calendaring in plantext files. The calendar consists of 2 files:
|
||||
|
||||
|
||||
These are 2 scripts for calendaring in plantext files.
|
||||
|
||||
`calendar.txt` shows the current day at the top and continues down as far as the number of months you have rendered.
|
||||
|
||||
`calendar_archive.txt` contains all the days before current day.
|
||||
|
||||
calendar.txt looks like this:
|
||||
- `calendar_archive.txt` contains all the days before current day.
|
||||
- `calendar.txt` shows the current day at the top and continues down as far as the number of months that have been rendered. My calendar contains events and tasks for the current day. A typical day might look like:
|
||||
|
||||
```
|
||||
☼ sun nov 29
|
||||
water plants
|
||||
coop fed meeting
|
||||
⇃☾ tue dec 20
|
||||
|
||||
8 weekly meeting
|
||||
|
||||
9 website meeting
|
||||
|
||||
lunch with james
|
||||
|
||||
|
||||
◯ mon nov 30
|
||||
recycling
|
||||
|
||||
|
||||
———— December ————
|
||||
|
||||
☼ tue dec 01
|
||||
reading group
|
||||
|
||||
|
||||
☼ wed dec 02
|
||||
1pm appointment
|
||||
|
||||
|
||||
⇃◌ thu dec 03
|
||||
open hours at lab
|
||||
reply to jim
|
||||
laundry
|
||||
groceries
|
||||
locate receipts
|
||||
```
|
||||
|
||||
Events are at the top with a space inbetween them and the tasks for the day are below without spaces. As tasks and events are completed I move them to just below the day, sometimes with little notes. At the end of the day any uncompleted tasks will either get copied to the next day or migrated into my kanban task list in Obsidian. Then after midnight or next morning I run `calendarchive.sh` and start again for the next day.
|
||||
|
||||
I've been calendaring this way since fall of 2019.
|
||||
|
||||
I sync the notes between computers with SyncThing and edit them via Notational Velocity, TextEdit or Gedit, depending on what computer I'm on. In the future I think I might merge this plaintext notes folder with my markdown project notes in Obsidian.
|
||||
|
||||
## the scripts
|
||||
|
||||
### calendarender.sh
|
||||
|
||||
calendarender takes one argument and that's the number of months in the future you'd like to render. So say it's currently some day in November and I want to add the days in January to my calendar.txt, I would run `calendarender 2`. It then prints to the terminal as well as to the file.
|
||||
|
||||
Each day is rendered with `moon phase, day of the week, month, and day of the month`. Moon phases that are printed are: new, full, crescents and halfs. On any day that isn't one of those phases a sun is printed. If it's waxing an up-arrow will be printed, waning, down-arrow. It's not the _most_ accurate moon-phase algorithm but close enough for me :)
|
||||
|
||||
|
||||
### calendarchive.sh
|
||||
|
||||
if you run calendarchive without any arguments it will remove all days from calendar.txt that are before the current day and append them to the bottom of calendar_archive.txt. If it's late at night but before midnight you can run `calendarchive 1` and it'll also archive today as well (this doesn't work on linux though because of differences in how the `date` program works. Oh well.).
|
||||
|
||||
|
||||
|
||||
## installation + configuration
|
||||
1. clone or download the repo.
|
||||
|
||||
2. configure calendarender by opening calendarender.sh in your texteditor of choice and modify the line:
|
||||
2. open calendarender.sh in your texteditor of choice and find the line:
|
||||
|
||||
`calendarFile="/Users/YOU/WHEREYOURNOTESARE/calendar.txt"`
|
||||
|
||||
to say where your calendar file is. This must be the absolute path to your calendar file. If you don't have one just make an empty txt file there to start.
|
||||
This must be the absolute path to your calendar file. If you don't have one just make an empty txt file to start.
|
||||
|
||||
You might also like to configure recurring events. Recurring events really ought to be in a separate config file but currently they are hardcoded within the program itself. To add recurring events go down to where it says `############# render weekly things`. This section is broken down by day. There are a number of examples for Sundays that you can look at and modify for different days of the week/month. Anything in quotes after `echo` will be added to the calendar.
|
||||
To configure recurring events find where it says `############# render weekly things`. This section is broken down by day. There are a number of examples for Sundays that you can look at and modify for different days of the week/month. Anything in quotes after `echo` will be added to the calendar.
|
||||
|
||||
```
|
||||
#every sunday
|
||||
@ -58,7 +66,7 @@ You might also like to configure recurring events. Recurring events really ought
|
||||
#second sunday
|
||||
if [ "$dayOfWeek" = "Sun" ] && [ "$sunday" -eq 2 ]; then echo "example potluck">> $calendarFile; fi
|
||||
```
|
||||
_copy this to another day and change `Sun`, `sunday`, and `sunday` to that day. The 2 indicates this will be on the second sunday_
|
||||
_copy this to another day and change `Sun`, `sunday`, and `sunday` to another day. The 2 indicates this will be on the second sunday_
|
||||
|
||||
```
|
||||
#last sunday
|
||||
@ -76,29 +84,19 @@ Within calendarchive.sh, find the lines:
|
||||
|
||||
`calendarchive="/Users/YOU/YOURNOTESFOLDER/calendar_archive.txt"`
|
||||
|
||||
and modify them to point to your calendar files. Make sure both those exist at least as blank files.
|
||||
and modify them to point to the absolute path of your calendar files. Make sure both those exist at least as blank files.
|
||||
|
||||
4. you might need to `chmod +x` each of the scripts to make sure they're executable.
|
||||
|
||||
5. You can now just run them with `sh calendarchive.sh` or `sh calendarender.sh` but they're easier to use if they're in your path:
|
||||
5. You can now just run them with `sh calendarchive.sh` or `sh calendarender.sh`. I've added the following lines to `.bashrc` so that I can just run `arch` when I'm ready for the next day:
|
||||
|
||||
Copy the scripts somewhere like `~/bin` and add `export PATH=$PATH:~/bin` to `~/.bashrc`
|
||||
```
|
||||
function arch() {
|
||||
cd ~/notes
|
||||
sh calendarchive.sh
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## usage
|
||||
|
||||
My personal notes folder is plain text synced between machines with SyncThing and edited via Notational Velocity or TextEdit or Gedit, etc. I keep calendar.txt, calendar_archive.txt and all sorts of other notes in there. I've been calendaring this way since fall of 2019.
|
||||
|
||||
|
||||
### calendarender
|
||||
|
||||
calendarender takes one argument and that's the number of months in the future you'd like to render. So say it's currently some day in November and I want to add the days in January to my calendar.txt, I would run `calendarender 2`. It'll print to the terminal as well as to the file.
|
||||
|
||||
calendarender also prints relevant moon phases: new, full, crescents and halfs. On any day that isn't one of those phases a sun is printed. If it's waxing an up-arrow will be printed, waning, down-arrow. It's not the _most_ accurate moon-phase algorithm but close enough for me :)
|
||||
|
||||
|
||||
### calendarchive
|
||||
|
||||
if you run calendarchive without any arguments it will remove all days from calendar.txt that are before the current day and append them to the bottom of calendar_archive.txt. If it's late at night but before midnight you can run `calendarchive 1` and it'll also archive today as well (this doesn't work on linux though because of differences in how the `date` program works. Oh well.).
|
||||
|
||||
you could cron calendarchive to have it automatically run but personally I keep all kinds of notes and things in my calendar and don't want to lose track of anything. So I manually run calendarchive.
|
||||
|
||||
Reference in New Issue
Block a user