README

   1
   2 This is the README file for Planner.
   3
   4 Synopsis
   5 ========
   6
   7 Planner is an organizer and day planner for Emacs.  It helps you keep
   8 track of your pending and completed tasks, daily schedule, dates to
   9 remember, notes and inspirations.  It is a powerful tool not only for
  10 managing your time and productivity, but also for keeping within easy
  11 keystroke reach all of the information you need to be productive.  It
  12 can even publish reports charting your work for your personal web
  13 page, your conscience, or your soon-to-be-impressed boss.
  14
  15 In fact, because it uses as its building blocks simple plain-text
  16 files, it is an incredibly modular and flexible tool capable of
  17 shaping and handling your personal information in ways whose variety
  18 is limited only by your imagination.  Because of this, Planner has a
  19 very active and generous community who regularly share their
  20 innovations with each other.  Many of these modules and extensions are
  21 included.
  22
  23 Directory contents
  24 ==================
  25
  26 The directory structure is as follows.
  27
  28 top level :: Planner source code and the documentation
  29              (planner-el.texi).
  30
  31 contrib :: Files that are not a part of Planner proper, but are useful
  32            enough to be bundled with Planner.
  33
  34 scripts :: Scripts that are used when compiling Planner.
  35
  36 Getting started
  37 ===============
  38
  39 Compilation
  40 -----------
  41
  42 This is an optional step, since Emacs Lisp source code does not
  43 necessarily have to be byte-compiled.  It will yield a speed increase,
  44 though.
  45
  46 A working copy of Emacs or XEmacs is needed in order to compile
  47 Planner.  By default, the program that is installed with the name
  48 `emacs' will be used.
  49
  50 If you want to use the `xemacs' binary to perform the compilation, you
  51 would need to edit `Makefile.defs' in the top-level directory as
  52 follows.  You can put either a full path to an Emacs or XEmacs binary
  53 or just the command name, as long as it is in the PATH.
  54
  55 EMACS    = xemacs
  56 SITEFLAG = -no-site-file
  57
  58 In order for Planner to be byte-compiled properly, you will need to
  59 specify the paths to Muse and other external software programs in
  60 `scripts/planner-build.el'.  If a file fails to be byte-compiled, only
  61 its source will be installed.
  62
  63 Running `make' should compile the Planner source files in the `lisp'
  64 directory.
  65
  66 Installation
  67 ------------
  68
  69 Planner may be installed into your file hierarchy by doing the
  70 following.
  71
  72 Edit the `Makefile.defs' file so that ELISPDIR points to where you
  73 want the source and compiled Planner files to be installed and INFODIR
  74 indicates where to put the Planner manual.  Of course, you will want
  75 to edit EMACS and SITEFLAG as shown in the Compilation section if you
  76 are using XEmacs.
  77
  78 If you are installing Planner on a Debian system, you might want to
  79 change the value of INSTALLINFO as specified in `Makefile.defs'.
  80
  81 If you wish to install Planner to different locations than the
  82 defaults specify, edit `Makefile.defs' accordingly.
  83
  84 Run `make' as a normal user.
  85
  86 Run `make install' as the root user if you have chosen installation
  87 locations that require this.
  88
  89 Insinuation
  90 -----------
  91
  92 Two things need to happen in order for Planner to be usable with your
  93 version of Emacs or XEmacs.
  94
  95  1. The location of the Planner directory needs to be added to the load
  96     path so that your variant of Emacs can find it.
  97
  98  2. You need to load whichever Planner files you wish to make use of.
  99
 100 A quick example that accomplishes both of these follows.
 101
 102 ;; Add this to your .emacs or .xemacs/init.el file.
 103 (add-to-list 'load-path "/path/to/planner")
 104 (require 'planner)
 105
 106 Documentation
 107 -------------
 108
 109 The Planner manual may be generated by running `make doc'.
 110
 111 It will produce two files: an Info file called `planner-el.info' and
 112 an HTML document called `planner-el.html'.
 113
 114 This manual is also available online in several forms.
 115
 116  - PDF: http://www.mwolson.org/static/doc/planner.pdf
 117  - HTML (single file): http://www.mwolson.org/static/doc/planner.html
 118  - HTML (multiple files): http://www.mwolson.org/static/doc/planner/
 119
 120 Further Documentation
 121 =====================
 122
 123 Planner has an official website at http://www.plannerlove.com/.  It is
 124 a collaborative wiki.
 125
 126 Bugs may be reported using the Planner Bug-Tracker at
 127 https://gna.org/bugs/?group=planner-el.
 128
 129 A mailing list for Planner and some related software exists; consult
 130 http://www.emacswiki.org/cgi-bin/wiki/EmacsWikiMailingList for details
 131 on joining it or viewing its contents.