README

   1 Nyuron 4.1.4 Readme
   2
   3 A calendar & notepad for ruby programmers,
   4 using sqlite3 and ncurses.
   5
   6 You can:
   7
   8 *  edit or write own commands, sort or tabcompletion routines
   9    from inside a running Nyuron process.
  10 *  use a well documented API for such tasks, that does the painful work
  11 *  tag your notes and filter them to only see what you want to see
  12 *  assing times to your notes and be warned before they occur.
  13 *  program actions for when timed notes expire, or make them reoccur
  14 *  integrate information about important events in your window manager
  15
  16 and if you work on the source code, you can do anything :P
  17
  18 __________________________________________________
  19
  20 Section one: installing & using
  21
  22 Software requirements:
  23 * ruby1.8
  24 * ruby1.8-sqlite3
  25 * ruby1.8-ncurses
  26
  27
  28 The first things you'll want to do after installing it:
  29
  30 *  copy the file `db' to `~/.nyudb'
  31 *  copy `nyuron.conf' to `~/.nyurc'. apply any changes
  32    you want. it is a ruby script and will be eval'd
  33    by the nyuron program.
  34 *  run nyuron, take a look at the introduction,
  35    then press 1 or 2 to list all commands or keymaps
  36 *  add your notes and have fun
  37
  38 *  if needed, use rdoc to create a documentation of the code
  39
  40 __________________________________________________
  41
  42 Section two: for coders
  43
  44 Rules for version naming:
  45 a) Basic pattern: X.Y.Z (for example 2.6.3)
  46    If Z is 0, use X.Y instead (like 2.6)
  47 b) Numbers are always raised by 1.
  48    When this happens, all following numbers are reset to 0
  49 c) Rewrites increase X
  50 d) New stable versions increase Y
  51 e) Experimental Versions increase Z
  52
  53 => Stable versions are usually X.Y.0
  54 => Version X.0.0 is *not* stable, but a fresh rewrite
  55
  56
  57 Coding style:
  58 *  Tabs for indentation, spaces for tables and such
  59 *  Try to keep modules generic, classes independend
  60    and with little interactions.
  61 *  Comment functions and classes with rdoc in mind
  62 *  Use syntax compatible to both ruby1.8 and ruby1.9
  63    at least until ruby1.9 works well enough
  64