Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 48 lines (34 sloc) 2.904 kb
ab074f9 @stefanoverna Added Wordpress plugin readme.txt
stefanoverna authored
1 === Plugin Name ===
2 Contributors: welaika, stefano.verna
3 Donate link: https://github.com/welaika/wordless
4 Tags: sass, compass, haml, rails
5 Requires at least: 3.0
6 Tested up to: 3.2
7 Stable tag: trunk
8
9 Wordless dramatically speeds up and enhances your custom themes
10 creation, thanks to Sass, Compass, Haml and Coffeescript.
11
12 == Description ==
13
d344c53 @markjaquith Correct "Wordpress" to "WordPress" in docs and code comments
markjaquith authored
14 Wordless is an opinionated WordPress plugin that dramatically speeds up and enhances your custom themes creation. Some of its features are:
ab074f9 @stefanoverna Added Wordpress plugin readme.txt
stefanoverna authored
15
16 * A structured, organized and clean [theme organization](https://github.com/welaika/wordless/tree/master/wordless/theme_builder/vanilla_theme) (taken directly from Rails);
d344c53 @markjaquith Correct "Wordpress" to "WordPress" in docs and code comments
markjaquith authored
17 * Ability to create a new theme skeleton directly within the WordPress backend interface;
ab074f9 @stefanoverna Added Wordpress plugin readme.txt
stefanoverna authored
18 * Ability to write PHP code using the beautiful [Haml templating system](http://haml-lang.com/);
19 * Ability to write CSS stylesheets using the awesome [Sass syntax](sass-lang.com) and the [Compass framework](http://compass-style.org/);
20 * Ability to write [Coffeescript](http://jashkenas.github.com/coffee-script/) instead of the boring, oldish Javascript;
21 * A growing set of handy and documented helper functions ready to be used within your views;
22
23 You can always find the latest version of this plugin, as well as a
24 detailed README, on [Github](https://github.com/welaika/wordless).
25
26 == Installation ==
27
d344c53 @markjaquith Correct "Wordpress" to "WordPress" in docs and code comments
markjaquith authored
28 1. Your development machine needs a ruby environment, and the [compass](https://github.com/chriseppstein/compass), [sprockets](https://github.com/sstephenson/sprockets) and [coffee-script](https://github.com/josh/ruby-coffee-script) gem. See below to see how to setup WordPress on your machine using RVM;
ab074f9 @stefanoverna Added Wordpress plugin readme.txt
stefanoverna authored
29 2. The production machine doesn't need any extra-dependencies, as all the compiled assets automatically get statically backend by Wordless;
30 3. [Download the Wordless plugin](https://github.com/welaika/wordless/zipball/master), drop it in the `wp-content/plugins` directory and enable it from the WP "Plugins" section;
31 4. Enable the use of nice permalinks from the WP "Settings > Permalink" section. That is, we need the .htaccess file;
32 5. Create a brand new Wordless theme directly within the WP backend, from the WP "Appearance > New Wordless Theme" section;
33 6. Specify the path of your ruby executables, you can do it within your theme's `config/initializers/wordless_preferences.php` config file.
34
35 **RVM (recommended setup)**
36
37 It's recommended to use [RVM](http://rvm.beginrescueend.com) to handle ruby gems. Type the following from your terminal:
38
39 rvm use 1.8.7
40 rvm gemset create wordless
41 rvm use 1.8.7@wordless
42 gem install sprockets compass coffee-script
43 rvm wrapper 1.8.7@wordless wordless compass ruby
44
45 Now you should be able to know the location of your RVM-wrapped ruby executables using `which wordless_ruby` and `which wordless_compass`. Write them down into the `config/initializers/wordpress_preferences.php` file.
46
47
Something went wrong with that request. Please try again.