README.md

   1 # indicator-lunar-calendar
   2
   3 An application indicator for Unity that displays the current date and time
   4 in lunar calendar.
   5
   6 Copyright (c) 2016 Adrian I Lam <adrianiainlam@gmail.com>
   7
   8 *Not to be confused with [indicator-lunar][1], which shows attributes and
   9 ephemerides for astronomical objects.*
  10
  11 [1]: https://launchpad.net/~thebernmeister/+archive/ubuntu/ppa
  12
  13 ## Dependencies
  14
  15  - [Node.js][2]
  16
  17    Note: node-gtk, one of this program's dependencies, requires nodejs version
  18    5 or above.
  19
  20    [2]: https://nodejs.org/en/
  21
  22  - [node-gtk][3] (by @WebReflection)
  23
  24    npm package: https://www.npmjs.com/package/node-gtk
  25
  26    Dependencies: build-essential, git, nodejs (>= 5), gobject-introspection,
  27    libgirepository1.0-dev
  28
  29    Note: This package failed to build for me. I had to remove `-Werror` from
  30    `cflags` in file "bindings.gyp" to get it to build.
  31
  32    [3]: https://github.com/WebReflection/node-gtk
  33
  34  - [lunar-calendar-zh][4] (by @roadmanfong)
  35
  36    npm package: https://www.npmjs.com/package/lunar-calendar-zh
  37
  38    Note: This package contains a bug which renders it useless if your computer
  39    is set to a time zone which observes Daylight Saving. I have forked it and
  40    fixed it in <https://github.com/adrianiainlam/LunarCalendar>.
  41
  42    [4]: https://github.com/roadmanfong/LunarCalendar
  43
  44  - [node-cron][5] (by @ncb000gt)
  45
  46    npm package: https://www.npmjs.com/package/cron
  47
  48    [5]: https://github.com/ncb000gt/node-cron
  49
  50 ## Usage
  51
  52  1. Install the dependencies listed above.
  53  2. Clone this repository.
  54  3. Add the script as a startup application.
  55  4. Run the script manually for the first time. (Alternatively, log out
  56     and log in again.)
  57  5. The indicator should be shown at the top right corner, having an icon
  58     that shows the year and a label that shows the month and date.
  59  6. Clicking on the indicator should result in a menu with more detailed
  60     information including the time.
  61
  62 ## License
  63
  64 This program is released under the MIT License. For the full text of this
  65 license, please refer to the file "indicator-lunar-calendar.js".