Skip to content
This repository has been archived by the owner on Mar 31, 2023. It is now read-only.

Commit

Permalink
Merge pull request #224 from fourkitchens/hotfix/readme-php-update
Browse files Browse the repository at this point in the history
change drush script info to php script
  • Loading branch information
Evan Willhite committed May 10, 2018
2 parents 8b69009 + 35eb70e commit 0259f75
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ Component-driven prototyping tool using [Pattern Lab v2](http://patternlab.io/)

## Requirements

1. [Node (we recommend NVM)](https://github.com/creationix/nvm)
2. [Gulp](http://gulpjs.com/)
3. [Composer](https://getcomposer.org/)
4. Optional: [Yarn](https://github.com/yarnpkg/yarn)
1. [Node (we recommend NVM)](https://github.com/creationix/nvm)
2. [Gulp](http://gulpjs.com/)
3. [Composer](https://getcomposer.org/)
4. Optional: [Yarn](https://github.com/yarnpkg/yarn)

## Quickstart (Emulsify Standalone)

Emulsify supports both NPM and YARN.

Install with NPM:
Expand All @@ -24,12 +25,12 @@ Install with Yarn:

### In a Composer-based Drupal install (recommended)

1. `composer require fourkitchens/emulsify`
2. Enable Emulsify and its dependencies `drush en emulsify components unified_twig_ext -y`
3. **Optional**: Create cloned theme `drush emulsify "THEME NAME"` (You may need to run `drush cc drush` to clear the drush cache. Also, you can run `drush help emulsify` for other available options)
4. If you created a cloned theme, `cd web/themes/custom/THEME_NAME/`. If not, `cd web/themes/contrib/emulsify/`
5. `npm install` or `yarn install`
6. If you created a cloned theme, disable the original Emulsify theme `drush pmu emulsify -y` and enable your new theme in Drupal and set to default.
1. `composer require fourkitchens/emulsify`
2. Enable Emulsify and its dependencies `drush en emulsify components unified_twig_ext -y`
3. **Optional**: Create cloned theme `php emulsify.php "THEME NAME"` (Run `php emulsify.php -h` for other available options)
4. If you created a cloned theme, `cd web/themes/custom/THEME_NAME/`. If not, `cd web/themes/contrib/emulsify/`
5. `npm install` or `yarn install`
6. If you created a cloned theme, disable the original Emulsify theme `drush pmu emulsify -y` and enable your new theme in Drupal and set to default.

If you're not using a Composer-based Drupal install (e.g. tarball download from drupal.org) installation [instructions can be found on the Wiki](https://github.com/fourkitchens/emulsify/wiki/Installation).

Expand All @@ -39,9 +40,9 @@ Troubleshooting Installation: See [Drupal Installation FAQ](https://github.com/f

The `start` command spins up a local server, compiles everything (runs all required gulp tasks), and watches for changes.

1. `npm start` or `yarn start`
1. `npm start` or `yarn start`

---
---

## Highlighted Features

Expand All @@ -60,6 +61,7 @@ Forms, tables, video, accordion, cards, breadcrumbs, tabs, pager, status message
View a [demo of these default Emulsify components](https://fourkitchens.github.io/emulsify/pattern-lab/public/).

## Documentation

Documentation is currently provided in [the Wiki](https://github.com/fourkitchens/emulsify/wiki). Here are a few basic links:

#### General Orientation
Expand Down

0 comments on commit 0259f75

Please sign in to comment.