Skip to content
This repository has been archived by the owner on Sep 8, 2021. It is now read-only.

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
Bounced references to composer, not using. Also phpcs, not using either.
  • Loading branch information
digisavvymachine committed Jun 18, 2016
1 parent 4996f57 commit e62e2c4
Showing 1 changed file with 3 additions and 17 deletions.
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,7 @@ your theme! Cool. Right?

* Bower — We're using bower to manage certain theme dependencies, specifically Bourbon, Neat and Bi-App-Sass. Cool, right? That's what I said when I learned the awesomeness that is Bower. Ya hurd?!

* Composer — This one is a bit

* RTL Support via the most excellent bi-app-sass project
* PHPCS w/ WordPress Coding Standards
* Built for Accessibility
* Flexnav Menu System and Hover Intent
* TGM PLugin Activation
Expand All @@ -53,7 +50,7 @@ There's a lot to this theme, but don't be intimidated, even if you're not an "ad

Bourbon and Neat are used for providing simple Sass mixins and leverages a simple grid system that let's you markup your theme how you want, while you use their math, unlike Bootstrap and Foundation, presently.

There are things you need to install before you hack away at things. There are three package managers to install: Node (which installs the NPM package manager), Bower and Composer. Each of these have dependencies that also need to be installed. Fortunately, this is all "fairly easy".
There are things you need to install before you hack away at things. There are three package managers to install: Node (which installs the NPM package manager), Bower. Each of these have dependencies that also need to be installed. Fortunately, this is all "fairly easy".

* #### Prerequisites
* You'll need to download and install [Node](https://nodejs.org/)
Expand All @@ -64,7 +61,7 @@ There are things you need to install before you hack away at things. There are t
**git clone git://github.com/digisavvy/some-like-it-neat.git** – or [download](http://github.com/digisavvy/some-like-it-neat) it and then rename the directory to the name of your theme or website.


* #### Install Gulpjs, Composer and Bower + Dependencies
* #### Install Gulpjs, and Bower + Dependencies

Once you have Node, Sass and the theme installed, the next step is simple enough.

Expand All @@ -74,16 +71,6 @@ There are things you need to install before you hack away at things. There are t
* **Install Bower** - In the command prompt/terminal run this command: `npm install -g bower`. This installs Bower (the -g flag installs globally, not just in the current directory, super friends). Your only need to do this step once.
* **Install Bower Dependencies** - There are Sass and Js packages that are required by Some Like it Neat. To get them run this command: `bower install` - This will install the theme's dependencies such as bourbon, neat, flexnav etc.

* **Install Composer** - Install Composer, Globally, so that it will be available in your other projects, too! You only have to do this part once.
* [Install Composer](https://getcomposer.org/doc/00-intro.md#globally)

* **Install Composer Dependencies** - The only Composer Dependency setup at this time is PHPCS w/ WordPress Coding Standards. This allows us to run a Gulp task to "sniff" out any code in your theme that isn't standards-compliant. You can then go back and fix the offending code. The Phpcs task in gulpfile.js can be configured to included/exclude any directory within your theme. By default, it looks at php files in theme-root and files within the page-templates directory.

* Once you have completed the Composer install, you should be able to run the following command to install PHPCS: `php composer.phar install`.
* You can update the composer file via `sudo composer self-update` command.



* #### Set your project configuration in Gulpfile.js!!
_Be sure to go into gulpfile.js and setup the project configuration variables._

Expand Down Expand Up @@ -206,6 +193,7 @@ a project.
| ├── template-full-width.php
| ├── template-left-col.php
| └── template-right-col.php
| └── template-landing-page.php
├── .bowerrc
├── 404.php
├── archive.php
Expand All @@ -230,7 +218,6 @@ Road Map
---------------
* Firm up i18n for RTL and language support. Looking for contributors here
* Ensure Accessibility has been properly and thoroughly addressed
* Implement Yeoman
* <s>Get Bower properly setup and configured</s>


Expand Down Expand Up @@ -302,4 +289,3 @@ Bi-App-Sass
- Source: http://anasnakawa.github.io/bi-app-sass/
- License: the MIT License
- License URI: https://github.com/anasnakawa/bi-app-sass/blob/master/LICENSE

0 comments on commit e62e2c4

Please sign in to comment.