Skip to content
This repository was archived by the owner on Feb 7, 2023. It is now read-only.

Commit 26a0a00

Browse files
committed
hopefully simplifying setup instructions
1 parent 3d3ebc9 commit 26a0a00

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,11 @@ The Pattern Lab Standard Edition for Mustache is the evolution of Pattern Lab 1.
99

1010
You can play with a demo of the front-end of Pattern Lab at [demo.patternlab.io](http://demo.patternlab.io).
1111

12-
## Getting Started
12+
## Requirements
1313

14-
* [Requirements](http://patternlab.io/docs/requirements.html)
15-
* [Installing](#installing)
16-
* [Generating](http://patternlab.io/docs/first-run.html)
17-
* [Viewing](http://patternlab.io/docs/viewing-patterns.html)
18-
* [Editing](http://patternlab.io/docs/editing-source-files.html)
19-
* [Using commands](http://patternlab.io/docs/command-line.html)
20-
* [Upgrading](http://patternlab.io/docs/upgrading.html)
21-
* [More documentation](http://patternlab.io/docs/)
14+
To use the basic features of Pattern Lab to compile patterns, you must have **PHP 5.4+** installed. On Mac OS X Pattern Lab should work "out of the box." If you're on Windows you can [download PHP from PHP.net](http://windows.php.net/download/). Pattern Lab comes with its own built-in web server.
15+
16+
Pattern Lab uses [Composer](https://getcomposer.org/) to manage project dependencies. It's required if you want to install Pattern Lab using Composer's `create-project` command or if you want to upgrade Pattern Lab in the future.
2217

2318
## Installing
2419

@@ -48,7 +43,22 @@ Use Composer's [`create-project` command](https://getcomposer.org/doc/03-cli.md#
4843
1. In a terminal window navigate to the root of your project
4944
2. Type `composer create-project pattern-lab/edition-mustache-webdesignday your-project-name && cd $_`
5045

51-
This will install the Standard Edition for Mustache into a directory called `your-project-name` in `install/location/`. You will be automatically dropped into the project directory after the process is finished.
46+
This will install the Standard Edition for Mustache into a directory called `your-project-name` in `install/location/`. When prompted choose the "demo" StarterKit. You will be automatically dropped into the project directory after the process is finished.
47+
48+
## Get Up and Running
49+
50+
After installing do the following start Pattern Lab:
51+
52+
1. In a terminal window navigate to the root of your project if you aren't there already
53+
2. Type `php core/console --server --with-watch`
54+
55+
You should now be able to open [http://localhost:8080](http://localhost:8080) to see your generated site. Any changes you make in `./source/` will automatically rebuild your site and reload your browser.
56+
57+
As you get more comfortable with Pattern Lab you can [integrate it with a Gulp or Grunt workflow](http://patternlab.io/docs/advanced-integration-with-grunt.html) and drop some of the native Pattern Lab features like automatic browser reload.
58+
59+
## More Documentation
60+
61+
Obviously the reason to install Pattern Lab is more than the install process. [Check out the documentation](https://patternlab.io/docs/) to learn about how to use patterns, how to modify the data used to populate your patterns, and about some advanced features.
5262

5363
## Migrating from Pattern Lab 1 to Pattern Lab 2
5464

@@ -71,10 +81,11 @@ The Standard Edition for Mustache installs the following components:
7181

7282
* `pattern-lab/core`: [GitHub](https://github.com/pattern-lab/patternlab-php-core), [Packagist](https://packagist.org/packages/pattern-lab/core)
7383
* `pattern-lab/patternengine-mustache`: [documentation](https://github.com/pattern-lab/patternengine-php-mustache#mustache-patternengine-for-pattern-lab-php), [GitHub](https://github.com/pattern-lab/patternengine-php-mustache), [Packagist](https://packagist.org/packages/pattern-lab/patternengine-mustache)
84+
* `pattern-lab/plugin-reload`: [GitHub](https://github.com/pattern-lab/plugin-php-reload), [Packagist](https://packagist.org/packages/pattern-lab/plugin-reload)
7485
* `pattern-lab/styleguidekit-assets-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-assets-default), [Packagist](https://packagist.org/packages/pattern-lab/styleguidekit-assets-default)
7586
* `pattern-lab/styleguidekit-mustache-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-mustache-default), [Packagist](https://packagist.org/packages/pattern-lab/styleguidekit-mustache-default)
7687

77-
## List the Available Commands and Their Options
88+
## List All of the Available Commands and Their Options
7889

7990
To list all available commands type:
8091

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
"php": ">=5.3.6",
2828
"pattern-lab/core": "^2.0.0",
2929
"pattern-lab/patternengine-mustache": "^2.0.0",
30-
"pattern-lab/styleguidekit-mustache-default": "^3.0.0"
30+
"pattern-lab/styleguidekit-mustache-default": "^3.0.0",
31+
"pattern-lab/plugin-reload": "^2.0.0"
3132
},
3233
"scripts": {
3334
"server": "php core/console --server",

0 commit comments

Comments
 (0)