Skip to content

Commit e13e29a

Browse files
committed
added screenshot and usage
1 parent c946545 commit e13e29a

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,31 @@ Simple CLI calendar.
1010

1111
![Screenshot](https://github.com/raspi/kallu/blob/main/_assets/kallu_default.png)
1212

13+
![Screenshot](https://github.com/raspi/kallu/blob/main/_assets/kallu_count_next.png)
14+
15+
## Usage
16+
17+
```text
18+
kallu - simple CLI calendar
19+
Version v0.0.0 dev 0000-00-00T00:00:00+00:00
20+
(c) Pekka Järvinen 2022- [ https://github.com/raspi/kallu ]
21+
22+
Parameters:
23+
-count How many months per line default: "3"
24+
-dow Start day for week 0-6 (sun-sat) default: "1"
25+
-fullyear Print full year default: "false"
26+
-month Month 1-12 (defaults to current month) default: "6"
27+
-next How many next months default: "1"
28+
-one Only one month, equivalent to -next 0 -prev 0 default: "false"
29+
-prev How many previous months default: "1"
30+
-year Year (defaults to current year) default: "2022"
31+
32+
Examples:
33+
Full year:
34+
./kallu -fullyear
35+
Only this month:
36+
./kallu -one
37+
- equivalent to ./kallu -next 0 -prev 0
38+
One calendar at a time:
39+
./kallu -count 1
40+
```

_assets/kallu_count_next.png

56.4 KB
Loading

0 commit comments

Comments
 (0)