Skip to content

Commit 90729e7

Browse files
committed
updated README
1 parent 75cf4a7 commit 90729e7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Twig Templates for the Default StyleguideKit
2+
3+
These Twig templates are meant to be used with the [static assets](https://github.com/pattern-lab/styleguidekit-assets-default) for the default StyleguideKit. The Twig templates are for the "view all" view in Pattern Lab PHP.
4+
5+
## Installation
6+
7+
Pattern Lab PHP uses [Composer](https://getcomposer.org/) to manage project dependencies. To install the Mustache templates run:
8+
9+
composer require pattern-lab/styleguidekit-twig-default
10+
11+
## Development Requirements
12+
13+
In order to modify these templates you need to install the following:
14+
15+
* the [Twig Development Edition of Pattern Lab PHP](https://github.com/pattern-lab/edition-php-twig-development)
16+
17+
## Development Set-up
18+
19+
Once you've installed the requirements do the following to set-up for development:
20+
21+
1. `cd /path/to/dev-edition/packages/pattern-lab/styleguidekit-twig-default`
22+
2. `git config branch.dev.remote origin`
23+
24+
## Making Changes
25+
26+
Simply edit the files in `views/`.

0 commit comments

Comments
 (0)