mirror_php/patternlab-php
1
0
Fork 0
mirror of https://github.com/pattern-lab/patternlab-php.git synced 2025-01-17 06:08:23 +01:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Brad Frost 2014-03-15 19:33:05 -04:00
parent 52ac610f14
commit 8d3692313b
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,15 +1,13 @@
## About the PHP Version of Pattern Lab
The PHP version of Pattern Lab is, at its core, a static site generator. It combines platform-agnostic assets, like the [Mustache](http://mustache.github.io/)-based patterns and the JavaScript-based viewer, with a PHP-based "builder" that transforms and dynamically builds the Pattern Lab site. By making it a static site generator, the PHP version of Pattern Lab strongly separates patterns, data, and presentation from build logic. The PHP version should be seen as a reference for other developers to improve upon as they build their own Pattern Lab Builders in their language of choice.
The PHP version of Pattern Lab is, at its core, a static site generator. It combines platform-agnostic assets, like the [Mustache](http://mustache.github.io/)-based patterns and the JavaScript-based viewer, with a PHP-based "builder" that transforms and dynamically builds the Pattern Lab site. By making it a static site generator, Pattern Lab strongly separates patterns, data, and presentation from build logic.
## Demo
You can play with a demo of the front-end of the PHP version of Pattern Lab at [demo.pattern-lab.info](http://demo.pattern-lab.info).
You can play with a demo of the front-end of Pattern Lab at [demo.pattern-lab.info](http://demo.pattern-lab.info).
## Getting Started
The PHP version of Pattern Lab should be relatively easy for anyone to get up and running.
* [Requirements](http://pattern-lab.info/docs/requirements.html)
* [Installing the PHP Version of Pattern Lab](http://pattern-lab.info/docs/installation.html)
* [Upgrading the PHP Version of Pattern Lab](http://pattern-lab.info/docs/upgrading.html)
@ -46,7 +44,7 @@ The PHP version of Pattern Lab utilizes Mustache as the template language for pa
## Using Pattern Lab's Advanced Features
By default, the Pattern Lab assets can be manually generated and the Pattern Lab site manually refreshed but who wants to waste time doing that? Here are some ways that the PHP version of Pattern Lab can make your development workflow a little smoother:
By default, the Pattern Lab assets can be manually generated and the Pattern Lab site manually refreshed but who wants to waste time doing that? Here are some ways that Pattern Lab can make your development workflow a little smoother:
* [Watching for Changes and Auto-Regenerating Patterns](http://pattern-lab.info/docs/advanced-auto-regenerate.html)
* [Auto-Reloading the Browser Window When Changes Are Made](http://pattern-lab.info/docs/advanced-reload-browser.html)
@ -56,4 +54,4 @@ By default, the Pattern Lab assets can be manually generated and the Pattern Lab
* [Preventing the Cleaning of public/](http://pattern-lab.info/docs/advanced-clean-public.html)
* [Generating CSS](http://pattern-lab.info/docs/advanced-generating-css.html)
* [Modifying the Pattern Lab Nav](http://pattern-lab.info/docs/advanced-pattern-lab-nav.html)
* [Integration with Compass](http://pattern-lab.info/docs/advanced-integration-with-compass.html)
* [Integration with Compass](http://pattern-lab.info/docs/advanced-integration-with-compass.html)