README.md in marv-0.2.1 vs README.md in marv-0.2.2

- old
+ new

@@ -1,49 +1,62 @@ -## Introduction +## What is Marv? -Marv is a toolkit for bootstrapping and developing WordPress themes using Sass, LESS, and CoffeeScript. +Marv is a free command-line toolkit for bootstrapping and developing WordPress themes in a tidy environment using front-end languages like Sass, LESS, and CoffeeScript. [![Gem Version](https://badge.fury.io/rb/marv.svg)](http://badge.fury.io/rb/marv) ------ -## Installation +## How does it work? -Install Marv (requires [Ruby](http://www.ruby-lang.org/) and [RubyGems](http://rubygems.org/)): +Marv creates a neatly organized source folder with clean and simple scaffolding (base template files, SCSS files). The source folder is automatically compiled to your local WordPress install(s) as you save changes and work on your theme. When you are ready to distribute your theme Marv will build it to a folder of your choice or bundle the theme up into an easy to install zip package. - $ gem install marv +## Why use Marv? -## Get started +Marv accelerates development by giving you access to higher-level languages like Sass, LESS, and CoffeeScript. These languages are much quicker and cleaner to code, but still compile to normal CSS and JavaScript. Marv also makes it easy to quickly bootstrap into and a more modular development environment, while still compiling "by the book" WordPress theme code. -Create your new theme project: - $ marv create your_theme +## Basic setup -Change to your new project directory: +Install Marv (requires [Ruby](http://www.ruby-lang.org/) and [RubyGems](http://rubygems.org/)): - $ cd your_theme + $ gem install marv +Create your new theme project: + + $ marv create themename + Link to your WordPress theme folder: - $ marv link /path/to/wordpress/wp-content/themes/your_theme + $ marv link /wordpress/wp-content/themes/my-theme Watch for changes and start developing! + $ cd themename $ marv watch -Press Ctrl + Z to exit watch mode + Press Ctrl + Z to exit watch mode Build your theme into the build_here directory: $ marv build build_here -Package your theme as your_theme.zip: +Package your theme as themename.zip: - $ marv package your_theme + $ marv package themename ## Help Get a little help with the Marv commands: - $ marv help + $ marv help + + +See the [user's manual](https://github.com/hardpixel/marv/wiki) for more information. + + +## Credits + +Marv is based on [Forge](https://github.com/thethemefoundry/forge) by ThemeFoundry. + +Scaffold Wordpress theme is based on [WP-Scaffold](https://github.com/gizburdt/wp-scaffold) by Gizburdt. \ No newline at end of file