README

Oak Template Generator

The Treehouse Internet Group

Template generator for Oak

Getting Started

Open your terminal or you can download iTerm(Mac only) here

You'll need to install Node.js: here

You'll need to install npm, gulp, and slush:

$ sudo npm install -g npm
$ sudo npm install -g slush
$ sudo npm install -g gulp

Install Oak generator

Install slush-oak globally:

$ sudo npm install -g slush-oak

Create a new folder for your project in a location of your choice:

$ mkdir xxxx-slush-oak

Navigate to your new folder:

$ cd xxxx-slush-oak

Time to gather content:

Refer to oak generator question list here

Ready to generate?

On your mark, get set, go run the generator in your xxxx-slush-oak folder!

$ slush oak

Now what?

You successfully entered your content into the generator, now what?
Now you should see a dest folder in your xxxx-slush-oak folder.
What are you waiting for open it!
Inside you will find some familiar file names, borders.php, template.css and screen.css.
Open them up in your favorite editor and paste them into the CMS, and that's it.

Post generator tweaks

Now I hope you didn't think you were gonna paste those files in and poof, "site ready for review". There will certainly be some code tweaking to do. But hey, the boring part's out of the way....content, now time to work your magic and make that site pop!

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Usage no npm install needed!