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 License
  24 =======
  25
  26 Planner is free software; you can redistribute it and/or modify it
  27 under the terms of the GNU General Public License as published by the
  28 Free Software Foundation; either version 2, or (at your option) any
  29 later version.
  30
  31 Planner is distributed in the hope that it will be useful, but WITHOUT
  32 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  33 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  34 for more details.
  35
  36 You should have received a copy of the GNU General Public License
  37 along with Planner; see the file COPYING.  If not, write to the Free
  38 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  39 02110-1301, USA.
  40
  41 Directory contents
  42 ==================
  43
  44 The directory structure is as follows.
  45
  46 top level :: Planner source code and the documentation
  47              (planner-el.texi).
  48
  49 contrib :: Files that are not a part of Planner proper, but are useful
  50            enough to be bundled with Planner.
  51
  52 scripts :: Scripts that are used when compiling Planner.
  53
  54 Getting started
  55 ===============
  56
  57 Compilation
  58 -----------
  59
  60 This is an optional step, since Emacs Lisp source code does not
  61 necessarily have to be byte-compiled.  It will yield a speed increase,
  62 though.
  63
  64 A working copy of Emacs or XEmacs is needed in order to compile
  65 Planner.  By default, the program that is installed with the name
  66 `emacs' will be used.
  67
  68 You will also need to have Emacs Muse installed.  See
  69 http://www.plannerlove.com/pmwiki/pmwiki.php?n=Main.DownloadingPlanner
  70 for current information on which release of Muse to get,
  71
  72 If Muse is not present in the `~/elisp/muse' directory on your system,
  73 you will have to change the line that mentions Muse in
  74 `scripts/planner-build.el' to something like the following, replacing
  75 PATH with the path to Muse.
  76
  77 (add-to-list 'load-path "PATH/lisp")
  78
  79 If you want to use the `xemacs' binary to perform the compilation, you
  80 would need to edit `Makefile.defs' in the top-level directory as
  81 follows.  You can put either a full path to an Emacs or XEmacs binary
  82 or just the command name, as long as it is in the PATH.
  83
  84 EMACS    = xemacs
  85 SITEFLAG = -no-site-file
  86
  87 In order for Planner to be byte-compiled properly, you will need to
  88 specify the paths to Muse and other external software programs in
  89 `scripts/planner-build.el'.  If a file fails to be byte-compiled, only
  90 its source will be installed.
  91
  92 Running `make' should compile the Planner source files in the `lisp'
  93 directory.
  94
  95 Installation
  96 ------------
  97
  98 Planner may be installed into your file hierarchy by doing the
  99 following.
 100
 101 Edit the `Makefile.defs' file so that ELISPDIR points to where you
 102 want the source and compiled Planner files to be installed and INFODIR
 103 indicates where to put the Planner manual.  Of course, you will want
 104 to edit EMACS and SITEFLAG as shown in the Compilation section if you
 105 are using XEmacs.
 106
 107 If you are installing Planner on a Debian system, you might want to
 108 change the value of INSTALLINFO as specified in `Makefile.defs'.
 109
 110 If you wish to install Planner to different locations than the
 111 defaults specify, edit `Makefile.defs' accordingly.
 112
 113 Run `make' as a normal user.
 114
 115 Run `make install' as the root user if you have chosen installation
 116 locations that require this.
 117
 118 Insinuation
 119 -----------
 120
 121 Two things need to happen in order for Planner to be usable with your
 122 version of Emacs or XEmacs.
 123
 124  1. The location of the Planner directory needs to be added to the load
 125     path so that your variant of Emacs can find it.
 126
 127  2. You need to load whichever Planner files you wish to make use of.
 128
 129 A quick example that accomplishes both of these follows.
 130
 131 ;; Add this to your .emacs or .xemacs/init.el file.
 132 (add-to-list 'load-path "/path/to/planner")
 133 (require 'planner)
 134
 135 Documentation
 136 -------------
 137
 138 The Planner manual may be generated by running `make doc'.
 139
 140 It will produce two files: an Info file called `planner-el.info' and
 141 an HTML document called `planner-el.html'.
 142
 143 This manual is also available online in several forms.
 144
 145  - PDF: http://www.mwolson.org/static/doc/planner.pdf
 146  - HTML (single file): http://www.mwolson.org/static/doc/planner.html
 147  - HTML (multiple files): http://www.mwolson.org/static/doc/planner/
 148
 149 Further Documentation
 150 =====================
 151
 152 Planner has an official website at http://www.plannerlove.com/.  It is
 153 a collaborative wiki.
 154
 155 Bugs may be reported using the Planner Bug-Tracker at
 156 https://gna.org/bugs/?group=planner-el.
 157
 158 A mailing list for Planner and some related software exists; consult
 159 http://www.plannerlove.com/pmwiki/pmwiki.php?n=Main.Community for
 160 details on joining it or viewing its contents.