mermshaus / phpsog Goto Github PK

phpsog - PHP Static Output Generator

The software is published under the MIT License (see LICENSE).

This is a very early release.

Marc Ermshaus <[email protected]>


Take a look at webdevbuch <https://github.com/mermshaus/webdevbuch> to see how
phpsog may be used as a build tool within a project. A live version of the
compiled project is available at <http://buch.ermshaus.org/>.

If phpsog is not what you are looking for, you might want to try Victor
Farazdagi’s phrozn <http://www.phrozn.info/>.


Setup
-----

This step is needed to set up your phpsog distribution. phpsog uses Composer
<http://getcomposer.org/> and Packagist <http://packagist.org/> for dependency
management.

    Note: Composer is a lightweight project-based package manager for PHP. That
    basically means two things:

    (1) You don’t have to install Composer on your system. It’s just a single
        .phar file you put in your project directory and it will work within
        that directory. There are no global implications of any kind. Also,
        Composer is not meant to be deployed to a production system. It is
        nothing but a setup tool.

    (2) „Composed“ projects have no global dependencies. Just upload the files
        generated by Composer to your web space. It will work like everything
        else without any additional demands to the environment.

Run the following commands from the project’s root directory to install the
dependencies. They will be written to the ./vendor subdirectory.

    $ curl -s http://getcomposer.org/installer | php
    $ php composer.phar install

All depedencies are listed in ./composer.json.


Compile the documentation
-------------------------

phpsog comes bundled with the source files for its documentation website. Run
the following command from the root directory to create the website in
./export/phpsogdoc.

    $ ./phpsog --project-dir=demos/phpsogdoc build