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 3, 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 3.03 or later installed.  See
  69 http://emacswiki.org/cgi-bin/wiki/PlannerModeQuickStart for current
  70 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 must copy `Makefile.defs.default' to `Makefile.defs' in the top-level
  81 directory, and then edit `Makefile.defs' as follows.  You can put
  82 either a full path to an Emacs or XEmacs binary or just the command
  83 name, as long as it is in the PATH.  Depending on your setup, changes
  84 to the PREFIX, ELISPDIR, and/or INFODIR variables may also need to be
  85 made.
  86
  87 EMACS    = xemacs
  88 SITEFLAG = -no-site-file
  89 # Edit the section as necessary
  90 install_info = install-info --section "XEmacs 21.4" $(1).info \
  91         $(INFODIR)/dir || :
  92
  93 In order for Planner to be byte-compiled properly, you will need to
  94 specify the paths to Muse and other external software programs in
  95 `scripts/planner-build.el'.  If a file fails to be byte-compiled, only
  96 its source will be installed.
  97
  98 Running `make' should compile the Planner source files in the `lisp'
  99 directory.
 100
 101 Installation
 102 ------------
 103
 104 Planner may be installed into your file hierarchy by doing the
 105 following.
 106
 107 Copy `Makefile.defs.default' to `Makefile.defs' in the top-level
 108 directory, if you haven't done so already.  Then edit the
 109 `Makefile.defs' file so that ELISPDIR points to where you want the
 110 source and compiled Muse files to be installed and INFODIR indicates
 111 where to put the Muse manual.  As mentioned earlier, you will want to
 112 edit EMACS and SITEFLAG as shown in the Compilation section if you are
 113 using XEmacs.
 114
 115 If you are installing Planner on a Debian system, you might want to
 116 change the value of INSTALLINFO as specified in `Makefile.defs'.
 117
 118 If you wish to install Planner to different locations than the
 119 defaults specify, edit `Makefile.defs' accordingly.
 120
 121 Run `make' as a normal user.
 122
 123 Run `make install' as the root user if you have chosen installation
 124 locations that require this.
 125
 126 Insinuation
 127 -----------
 128
 129 Two things need to happen in order for Planner to be usable with your
 130 version of Emacs or XEmacs.
 131
 132  1. The location of the Planner directory needs to be added to the load
 133     path so that your variant of Emacs can find it.
 134
 135  2. You need to load whichever Planner files you wish to make use of.
 136
 137 A quick example that accomplishes both of these follows.
 138
 139 ;; Add this to your .emacs or .xemacs/init.el file.
 140 (add-to-list 'load-path "/path/to/planner")
 141 (require 'planner)
 142
 143 Documentation
 144 -------------
 145
 146 The Planner manual may be generated by running `make doc'.
 147
 148 It will produce two files: an Info file called `planner-el.info' and
 149 an HTML document called `planner-el.html'.
 150
 151 This manual is also available online in several forms at
 152 http://www.wjsullivan.net/static/doc/planner/.
 153
 154 Further Documentation
 155 =====================
 156
 157 The maintainer of Planner has a webpage for it at
 158 http://www.wjsullivan.net/PlannerMode.html.
 159
 160 Bugs may be reported using the Planner Bug-Tracker at
 161 https://gna.org/bugs/?group=planner-el.
 162
 163 Planner has a collaborative wiki at
 164 http://emacswiki.org/cgi-bin/wiki/PlannerMode.
 165
 166 Mailing lists for Planner and some related software exists; consult
 167 https://gna.org/mail/?group=planner-el for details on joining them or
 168 viewing their contents.