Files
harbour-core/harbour/doc/en
Viktor Szakats 96e069c19e 2010-07-12 18:44 UTC+0200 Viktor Szakats (harbour.01 syenar.hu)
* include/hbextern.ch
  * src/rtl/Makefile
  + src/rtl/hbdoc.prg
    + Added __HBDOC_LOADDIR() internal RTL function to read
      NFDOC formatted documentation source directories into
      memory. The result will be a list of hashes which contain
      the raw content of doc files. The function does format
      validation (but not content) and add all agreed-on metadata
      to the hashes.
      It's a start and I hope others can join to create new
      layers of function for below functionality:
         - doc content validation
         - pre-formatting
         - output generators
      The goal is to avoid local solutions and standardize
      the format.

  + tests/hbdoctst.prg
    + Added small test app which will find and parse all
      documentation inside the Harbour source tree and
      save them in .hbd (serialized doc hash) format.
      Such .hdb files can be generated by the build process
      in the future, so tools like HBIDE can use the content
      to display intellisense or built-in help.
    ; TODO: HBQT doc/html should be removed as it's 
            hbdoc tools' job to convert HBDOC source 
            format to html or whatever else format needed.

  * harbour.spec
  * debian/rules
  - doc/man
  + src/pp/hbpp.1
  + src/main/harbour.1
  + utils/hbmk2/hbmk2.1
  + utils/hbtest/hbtest.1
  + utils/hbrun/hbrun.1
    * Moved man doc files to their own component dirs.

  * doc/Makefile
  * doc/en/Makefile
  + doc/clipper.txt
  - doc/en/clipper.txt
    * Moved non-NFDOC formatted doc file to doc dir.

  * doc/en/Makefile
    ! Fixed missing 1stread.txt

  * doc/en/hb_apigt.txt
  * doc/en/hbinet.txt
  * doc/en/tbrowse.txt
  * doc/en/hb_apifs.txt
    ! Fixed NFDOC non-standard entries.

  * bin/hbxpatch.hbs
    ! Fixed detecting dirs. (could cause errors only in rare cases)

  * contrib/hbdoc2/tmplates.prg
    * Formatting.
2010-07-12 16:47:24 +00:00
..

/*
 * $Id$
 */

/*  $DOC$
 *  $TEMPLATE$
 *     Document
 *  $NAME$
 *     OVERVIEW
 *  $CATEGORY$
 *     Document
 *  $ONELINER$
 *     HARBOUR Read me
 *  $DESCRIPTION$
 *
 *                        <b>The Harbour project</b>
 *
 * <b>************************************************************************</b>
 * <b>*  This file contains information on obtaining, installing, and using  *</b>
 * <b>*  Harbour. Please read it *completely* before asking for help.        *</b>
 * <b>************************************************************************</b>

 * Harbour is a free implementation of an xBase language compiler. It is
 * designed to be source code compatible with the CA-Cl*pper(r) compiler.
 * That means that if you've got some code that would compile using
 * CA-Cl*pper(r) then it should compile under Harbour. The Harbour-Project
 * web page is:
 *
 *              <b>http://harbour-project.org/</b>
 *
 * Status and other information is always available from the web site.
 * There is a Harbour mailing list. Harbour is still at a very early
 * stage of development, so the mailing list is very much a Developers
 * only list, although every body is welcome to join in the discussions.
 *
 * We would like you to join the Harbour development team. If you are
 * interested you may suscribe to our mailing list and start contributing
 * to this free public project.
 *
 * Please feel free to report all questions, ideas, suggestions, fixes,
 * code, etc. you may need and want. With the help of all of you, the Harbour
 * compiler and runtime libraries will become a reality very soon.
 *
 * <b>What this distribution contains</b>
 * ===============================
 *
 * This distribution is a Source code only distribution. It does not contain
 * any executable files. Executable versions of Harbour are available from
 * the web site. Executable versions of Harbour DO NOT create runable
 * programs. Harbour at the moment produces C output code, which must be
 * compiled with the Harbour Virtual Machine and the support libraries
 * in order to create a functioning program.
 * Please test running Harbour against your CA-Cl*pper source code and report
 * any problems that might occur.
 *
 * Very important: The preprocessor functionality is now working.
 *
 * <b>Installation</b>
 * ------------
 *
 * 1. Unzip with Harbour zip file using pkunzip or equivalent.
 *
 *         E.G. pkunzip -d build72.zip
 *
 *    This will create Harbour/ directory and all the relevant sub
 *    directories.
 *
 * 2. Compile Harbour using your C compiler. Make files for different
 *    platforms are included in the <WHERE ARE THEY?> directory.
 *
 * <b>--- COPYRIGHT ---</b>
 *
 * What copyright information do we have
 *
 * <b>--- LICENCE ---</b>
 *
 * Information about the License for usage of Harbour is available in the
 * file licence.txt (when we have a license)
 *
 * <b>--- DISCLAIMER ---</b>
 *
 * Participants of The Harbour Project assume no responsibility for errors or
 * omissions in these materials.
 *
 * <b>THESE MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.</b>
 *
 * Participants of The Harbour Project further do not warrant the accuracy or
 * completeness of the code, information, text, output or any other items
 * contained within these materials. Participants of The Harbour Project
 * shall not be liable for any special, direct, indirect, incidental, or
 * consequential damages, including without limitation, lost revenues or
 * lost profits, which may result from the use or mis-use of these materials.
 *
 * The information in The Harbour Project is subject to change without notice
 * and does not represent any future commitment by the participants of The
 * Harbour Project.
 *
 * The Harbour Project
 *
 *  $SEEALSO$
 *     License
 *  $END$
 */