README.md in reveal-ck-0.1.5 vs README.md in reveal-ck-0.1.6

- old
+ new

@@ -1,8 +1,9 @@ # reveal-ck: a [reveal.js][reveal-js] construction kit [![Build Status][travis-reveal-ck-badge]](https://travis-ci.org/jedcn/reveal-ck) +[![Code Climate][code-climate-reveal-ck-badge]](https://codeclimate.com/github/jedcn/reveal-ck) ## Overview This project is the home of a gem named `reveal-ck` that lets you quickly author [reveal.js](http://lab.hakim.se/reveal-js/) @@ -34,13 +35,13 @@ The thought behind this project to help you focus on what *you* want to say. For me, focusing becomes easier and my thoughts clearer when I reduce -the list of slides to a single file (`slides.slim` or -`slides.haml`). It only contains the slide content I am presenting and -there's minimal markup. +the list of slides to a single file (`slides.slim`, `slides.haml`, or +`slides.rb`). This file only contains the slide content that I am +presenting and there is minimal markup. * If you look at the presentation in a browser, you can't scan all of the slides at once. You need to visit them. If you're looking at a single file, you can quickly scan through 30+ slides. @@ -53,44 +54,27 @@ easier than if you track the generated presentation. In the end, [reveal.js][reveal-js], can make things pretty, but only you can make a presentation that is worthwhile. -## One Last Thought: Slides in Ruby +## Getting Started -Slim and Haml are decent, but the approach outlined so far means that -a user of reveal-ck needs to understand markup and conventions within -reveal.js. A templating language makes things less verbose, but it's -still a templating language. +You can author a set of slides by writing in a templating language, +such as [Slim][slim] or [Haml][haml], or you can build them +programmatically in ruby. Check out the +[getting started][reveal-ck-getting-started] instructions, and let me +know if you have any trouble. -If you'd like to go one step further, reveal-ck gives you the -opportunity to author slides in ruby. It comes with a small number of -pre-built templates that encapsulate reveal.js tag names, attributes, -and classes aside and provides classes that enable you to create -slides programmatically. See `examples/programmatic-slides.rb` for an -example. +## Development -What's more, once we've got programmatic support, it's not too much -harder to build a DSL. So, now you can create a file named `slides.rb` -(which replaces `slides.slim` or `slides.haml`) and write something -like this: +If you are interested in hacking on reveal-ck, check out the +[development page][reveal-ck-development]. -```ruby -slide 'title', - title: 'Here we go!', - author: 'Jed Northridge' - -slide 'quote', - content: "when you don't create things, you become defined by your tastes rather than ability. your tastes only narrow & exclude people. so create." - -['3', '2', '1', 'Contact!'].each do |s| - slide 'text', content: s -end -``` - -You can now run `reveal-ck generate` with `slides.rb` and build slides -in ruby. - -[jedcn-reveal-ck]: http://jedcn.com/posts/reveal-ck +[code-climate-reveal-ck-badge]: https://codeclimate.com/github/jedcn/reveal-ck.png [github-jedcn-reveal-ck-template]: http://github.com/jedcn/reveal-ck-template +[haml]: http://haml.info/ +[jedcn-reveal-ck]: http://jedcn.com/posts/reveal-ck +[reveal-ck-development]: https://github.com/jedcn/reveal-ck/blob/master/doc/development.md +[reveal-ck-getting-started]: https://github.com/jedcn/reveal-ck/blob/master/doc/getting_started.md [reveal-js]: http://lab.hakim.se/reveal-js +[slim]: http://slim-lang.com/ [travis-reveal-ck-badge]: https://travis-ci.org/jedcn/reveal-ck.png