1 # indicator-lunar-calendar
3 An application indicator for Unity that displays the current date and time
6 Copyright (c) 2016 Adrian I Lam <adrianiainlam@gmail.com>
8 *Not to be confused with [indicator-lunar][1], which shows attributes and
9 ephemerides for astronomical objects.*
11 [1]: https://launchpad.net/~thebernmeister/+archive/ubuntu/ppa
15 ![indicator normal][sc1]
16 Normal appearance of the indicator
18 ![indicator menu][sc2]
19 Menu of the indicator, shown on click
21 ![indicator with solar term][sc3]
22 Indicator showing solar term information
24 Note: The conversion is calculated using timezone UTC+8 (HKT), while the clock
25 shown above is using timezone UTC+1.
27 [sc1]: screenshots/sc1.png
28 [sc2]: screenshots/sc2.png
29 [sc3]: screenshots/sc3.png
35 Note: node-gtk, one of this program's dependencies, requires nodejs version
38 [2]: https://nodejs.org/en/
40 - [node-gtk][3] (by @WebReflection)
42 npm package: https://www.npmjs.com/package/node-gtk
44 Dependencies: build-essential, git, nodejs (>= 5), gobject-introspection,
45 libgirepository1.0-dev
47 Note: This package failed to build for me. I had to remove `-Werror` from
48 `cflags` in file "bindings.gyp" to get it to build.
50 [3]: https://github.com/WebReflection/node-gtk
52 - [lunar-calendar-zh][4] (by @roadmanfong)
54 npm package: https://www.npmjs.com/package/lunar-calendar-zh
56 Note: This package contains a bug which renders it useless if your computer
57 is set to a time zone which observes Daylight Saving. I have forked it and
58 fixed it in <https://github.com/adrianiainlam/LunarCalendar>.
60 [4]: https://github.com/roadmanfong/LunarCalendar
62 - [node-cron][5] (by @ncb000gt)
64 npm package: https://www.npmjs.com/package/cron
66 [5]: https://github.com/ncb000gt/node-cron
70 1. Install the dependencies listed above.
71 2. Clone this repository.
72 3. Add the script as a startup application.
73 4. Run the script manually for the first time. (Alternatively, log out
75 5. The indicator should be shown at the top right corner, having an icon
76 that shows the year and a label that shows the month and date.
77 6. Clicking on the indicator should result in a menu with more detailed
78 information including the time.
82 This program is released under the MIT License. For the full text of this
83 license, please refer to the file "indicator-lunar-calendar.js".