Location: PHPKode > projects > PhpScribe Documentation Generator > README.txt
phpScribe - README
===================

  Version 0.9 - December 2003
  ---------------------------
  http://phpscribe.sourceforge.net/

    Copyright (C) 2002-2003 Marcos Pont <hide@address.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  Requirements:
    PHP4 (>= 4.1)
    MySQL (>= 3.21.x)
    Web-Browser

  Summary:
    phpScribe is a project created to the web developers having as its main goal
    the generation of documentation files for projects by parsing the comment lines
    inserted in the source codes.

    The comments must be written in the code in a way they can be later interpreted
    by the parser. Therefore, there is a pattern that may be respected by the developers
    who want to use phpScribe features.

    At a first moment, the target language is PHP. In future, it will be possible to adapt
    this system of comment lines parsing to other languages focused on the Web or not.

  Download:
    You can get the newest version at http://phpscribe.sourceforge.net/.

  Credits:
    When running phpScribe, click on the link 'credits' in the bottom of the page.

  Installation:
    When you run phpScribe for the first time, the installation script is loaded automatically.
    After that, click 'Installation Settings' at the right menu if you want to change your settings.

  ChangeLog:
    See CHANGELOG.txt

  Hope you enjoy it!
    Marcos Pont
Return current item: PhpScribe Documentation Generator