@@ -1,22 +1,50 @@ -# Tarski Utilities +Tarski Utilities +================ -The files included in this repository constitute a toolset for working with [Tarski](http://tarskitheme.com/ "An elegant, flexible WordPress theme"), a [WordPress](http://wordpress.org/) theme. Hopefully they will prove useful to someone. +The files included in this repository constitute a toolset for working with +[Tarski][tarski], a [WordPress][wp] theme. Hopefully they will prove useful to +someone. -## Files -* __Rakefile__: some Rake tasks to tag and branch releases, create zip archives, generate an HTML version of the changelog file and update a version feed. -* __lib/tarski\_version.rb__: generates a version feed. Plugins mostly live in the WP plugin repository now, and get update notification for free, but since themes don't get this and update notification wasn't in WP core when I did it, I rolled my own. -* __conf/config.yml__: a general tarski-utilities configuration file; specify public paths and the like. -* __conf/version.yml__: a configuration file for the version feed generator. -* __conf/changelog-structure.html__: a wrapper for the HTML generated by the changelog task. +Tasks +----- -## Required Gems + rake changelog # Generate a new changelog HTML file. + rake feed # Update the version feed to notify Tarski users of + # the new release. + rake hooks # Generate the hooks documentation page. + rake plugin_version # Add version data to the Tarski website plugin. + rake update # Creates a zip archive, and updates the version feed + # and changelog. + rake zip # Create a zip file of the lastest release in the + # downloads directory. -These tools are written in Ruby, so they require the RubyGems packaging system and the following gems: -* [__Rake__](http://http://rake.rubyforge.org/ "Rake: Ruby Make"): to run the tasks. -* [__YAML__](http://www.yaml.org/ "YAML: YAML Ain't Markup Language"): reader and writer for the YAML file format, needed to read the config file. _Part of the Ruby standard library_. -* [__Builder__](http://builder.rubyforge.org/): programmatic XML generation, required to create the Tarski version feed. -* [__BlueCloth__](http://www.devEiate.org/projects/BlueCloth "A Ruby impelementation of Markdown"): Markdown format reader and writer, used to read Tarski's changelog file. -* [__Hpricot__](http://code.whytheluckystiff.net/hpricot/ "A fast and delightful HTML parser"): DOM scripting in Ruby for HTML and XML, used to parse the Tarski changelog and generate a list of links to each version's entry in the changelog. -* [__open-uri__](http://www.ruby-doc.org/stdlib/libdoc/open-uri/rdoc/): A wrapper for some other libraries which provide network protocol access, used to read remote files where necessary. _Part of the Ruby standard library_. +Required libraries +------------------ + +These tools are written in Ruby, so they require the RubyGems packaging system +and the following gems. [Git][git] is also a requirement. + +* [__Rake__][rake] to run the tasks. +* [__Builder__][builder]: programmatic XML generation, required to create the + Tarski version feed. +* [__RDiscount__][rdiscount]: Markdown format reader and writer, used to read + Tarski's changelog file. +* [__RubyPants__][rubypants]: Nicer typography with [SmartyPants][smartypants]. +* [__Hpricot__][hpricot]: DOM scripting in Ruby for HTML and XML, used to parse + the Tarski changelog and generate a list of links to each version's entry in + the changelog. + + +[tarski]: http://tarskitheme.com/ +[wp]: http://wordpress.org/ +[git]: http://git-scm.com/ +[rake]: http://http://rake.rubyforge.org/ +[yaml]: http://www.yaml.org/ +[builder]: http://builder.rubyforge.org/ +[rdiscount]: http://github.com/rtomayko/rdiscount/ +[rubypants]: http://chneukirchen.org/blog/static/projects/rubypants.html +[smartypants]: http://daringfireball.net/projects/smartypants/ +[hpricot]: http://code.whytheluckystiff.net/hpricot/ +[open_uri]: http://www.ruby-doc.org/stdlib/libdoc/open-uri/rdoc/ README.md f2b7fffa92b0ddbdbcb726c7020a103d173f87c2 Benedict Eastaugh benedict@eastaugh.net http://github.com/ionfish/tarski-utilities/commit/6ceebc509d67aa843dd3a0189fc52098c4831ee7 6ceebc509d67aa843dd3a0189fc52098c4831ee7 2009-08-11T17:01:18-07:00 2009-08-11T17:01:18-07:00 Update README. 93953ae497534165d5d908dafc108ab7dd682b32 Benedict Eastaugh benedict@eastaugh.net