cgit.sxemacs.org Git - packages/blob - xemacs-packages/oo-browser/BR-README

   1 # See "br-vers.el" for the OO-Browser lisp code directory entry.
   2 #
   3 # SUMMARY:      OO-Browser overview and installation notes
   4 #
   5 # AUTHOR:       Bob Weiner
   6 #
   7 # ORIG-DATE:    16-Jun-90
   8 # LAST-MOD:      3-Jan-02 at 18:16:36 by Bob Weiner
   9 #
  10 # Copyright (C) 2000-2002  Bob Weiner
  11 # Copyright (C) 1989-1999  BeOpen.com and the Free Software Foundation, Inc.
  12 #
  13 # See the file "BR-COPY" for license and support information.
  14 #
  15 # This file is part of the OO-Browser.
  16
  17 We hope you enjoy developing with the OO-Browser.  Feel free to mail or post
  18 news containing this file wherever it may be of use.
  19
  20 ===========================================================================
  21 *                       Table of Contents
  22 ===========================================================================
  23                         * Files
  24                         * How to Obtain
  25                         * Installation / Configuration
  26                         * Invocation
  27
  28
  29 ===========================================================================
  30 *                          Files
  31 ===========================================================================
  32
  33 See the "BR-FEATURES" file for a summary of OO-Browser features.
  34
  35 See the "BR-RELEASE" file for a summary of new features in this release.
  36
  37 See the "BR-COPY" file for license information.
  38
  39 See the "MANIFEST" file for summaries of the OO-Browser files.
  40
  41 "man/oo-browser.info" contains the Info version of the OO-Browser User
  42 Manual.
  43
  44
  45 ===========================================================================
  46 *                            How to Obtain
  47 ===========================================================================
  48
  49 The latest release of the OO-Browser may always be found at:
  50 "http://www.sf.net/projects/oo-browser".
  51
  52 You will need to obtain one archive which includes the source,
  53 machine-independent runtime and documentation (this archive does not mention
  54 an operating system) and then a second operating-system specific archive, if
  55 available, which contains binaries.
  56
  57 The OO-Browser works best when used together with the InfoDock integrated
  58 development environment.  InfoDock provides a modern user interface on top of
  59 XEmacs, information management, and powerful software development tools, all
  60 in one package.  The OO-Browser is available as part of InfoDock or as a
  61 standalone package for use with XEmacs or GNU Emacs.
  62
  63
  64 ===========================================================================
  65 *                     Installation / Configuration
  66 ===========================================================================
  67
  68 If you are using InfoDock, the OO-Browser is pre-configured so you can simply
  69 skip to the next section, Invocation.
  70
  71 The OO-Browser is provided in a turnkey fashion, with the Lisp files
  72 pre-compiled and binaries built for the client architecture.  But there
  73 are still a few installation steps.
  74
  75  1a. If this is a UNIX or Linux distribution (.tgz suffix):
  76
  77         You should have a *.tgz archive of the OO-Browser; we will call the
  78         absolute pathname to this archive <COMMON-TGZ-PATH>.  You may also
  79         have an operating system-specific archive of binaries which we'll
  80         call <BINARY-TGZ-PATH>.  Execute:
  81            gunzip <COMMON-TGZ-PATH>
  82            gunzip <BINARY-TGZ-PATH>
  83
  84         Then cd to the parent directory of where you want to install the
  85         OO-Browser and unpack the archive(s):
  86            cd <PARENT-DIR>
  87            tar xvf <COMMON-TGZ-PATH>
  88            tar xvf <BINARY-TGZ-PATH>
  89
  90  1b. If this is a MS Windows distribution (.zip suffix):
  91
  92         You should have a *.zip archive of the OO-Browser and possibly a
  93         zip archive of operating system-specific binaries.
  94         Change your working directory to the parent directory of where you
  95         want to install the OO-Browser:
  96            cd <PARENT-DIR>
  97
  98         Then unpack the zip archives you have using any .zip archive utility
  99         such as Winzip or Pkunzip.
 100
 101         NOTE: In this document we use forward slashes as directory separators
 102         within shell commands.  If you don't have a UNIX-type environment
 103         under Windows, you will have to use backward slashes.  For the lines
 104         that you add to your emacs initialization file, you can safely use
 105         forward slashes without any need for additional software.
 106
 107  1c. Execution of steps 1a or 1b creates the oo-browser/ directory (referred
 108      to as <OO-BROWSER-DIR> below) and several subdirectories.
 109
 110  2. If you have the separate Hyperbole information management package
 111     installed in your editor (available from
 112     "http://www.sf.net/projects/hyperbole"), you must be using V3.18.4 or
 113     greater; otherwise, upgrade.  You do not need to obtain Hyperbole
 114     but if it is installed you must have a recent version.
 115
 116  3. Add the following lines to your site autoload configuration or your
 117     personal initialization file, .emacs or .infodock, substituting
 118     the correct absolute pathname for <OO-BROWSER-DIR>:
 119
 120     If Hyperbole is installed, e.g. you run the OO-Browser under InfoDock
 121     (which includes Hyperbole), then add this expression:
 122
 123          (setq load-path (cons "<OO-BROWSER-DIR>/" load-path))
 124
 125     Otherwise, add this expression:
 126
 127          (setq load-path (append
 128                            '("<OO-BROWSER-DIR>/"
 129                              "<OO-BROWSER-DIR>/hypb/")
 130                            load-path))
 131
 132     Then following this load-path expression, add the following line
 133     regardless of whether you have Hyperbole:
 134
 135          (load "br-start")
 136
 137  4. Add the following key binding to your site keys configuration or your
 138     personal initialization file so that you can use {C-c C-o} to invoke
 139     the OO-Browser:
 140
 141          (global-set-key "\C-c\C-o" 'oo-browser)
 142
 143 Optional:
 144
 145  5. If you prefer to use some non-Emacs editor such as vi to view and edit
 146     your code, then modify to your taste the settings in the
 147     br-setup-external function in "br-site.el" and add the following line to
 148     your personal Emacs initialization file:
 149
 150          (add-hook 'br-mode-hook 'br-setup-external)
 151
 152  6. You may want to change the settings of `c++-cpp-include-dirs'
 153     and `c++-include-dirs' at the bottom of "<OO-BROWSER-DIR>/br-site.el".
 154     Then save the "br-site.el" buffer and use {M-x byte-compile-file RET RET}
 155     to create its .elc file.
 156
 157
 158  The OO-Browser is now ready for use.  Restart your editor before trying
 159  it.  See the Invocation section later in this document for how to start the
 160  browser or read the OO-Browser Manual.
 161
 162 -----
 163
 164                             Building from Scratch
 165
 166 If you prefer to build the OO-Browser from source yourself, you will need to
 167 follow the steps above for the pre-built distribution and then also follow
 168 the build process given below.  Otherwise, skip this section.
 169
 170     Once you have the newest Hyperbole version installed, you can safely
 171     delete the <OO-BROWSER-DIR>/hypb/ directory, which duplicates a subset of
 172     the Hyperbole files to provide the OO-Browser with context-sensitive
 173     keyboard and mouse keys.  But then you must make a symbolic link from
 174     your hyperbole directory to <OO-BROWSER-DIR>/hypb if you ever plan on
 175     using the OO-Browser Makefile.
 176
 177     The OO-Browser's Lisp files are pre-byte-compiled for InfoDock, Emacs 19
 178     or higher and for XEmacs, so if you run one of these versions, when you
 179     use `make' to build the OO-Browser, very few files will need to be built,
 180     so your make job will finish quickly.
 181
 182     To build and install the OO-Browser, follow the instructions in the USAGE
 183     section at the top of the "<OO-BROWSER-DIR>/Makefile".
 184
 185     The OO-Browser now should be ready for use.
 186
 187
 188 ===========================================================================
 189 *                           Invocation
 190 ===========================================================================
 191
 192 To invoke the OO-Browser, use:
 193
 194     {C-c C-o} or {M-x oo-browser RET}
 195
 196 Read the OO-Brower Manual to learn all about it.