Lucid
=====

[![Build Status](https://secure.travis-ci.org/jnyman/lucid.png)](http://travis-ci.org/jnyman/lucid)
[![Coverage Status](https://coveralls.io/repos/jnyman/lucid/badge.png?branch=master)](https://coveralls.io/r/jnyman/lucid)
[![Code Climate](https://codeclimate.com/github/jnyman/lucid.png)](https://codeclimate.com/github/jnyman/lucid)
[![Dependency Status](https://gemnasium.com/jnyman/lucid.png)](https://gemnasium.com/jnyman/lucid)
[![Gem Version](https://badge.fury.io/rb/lucid.png)](http://badge.fury.io/rb/lucid)


Description
-----------

Lucid is a Test Description Language (TDL) specification and execution engine. It is a clone of the popular tool [Cucumber](http://cukes.info/). Lucid is diverging in many ways from Cucumber but it does owe much of its initial structure to it. Lucid will also be incorporating some of the good ideas that have come to light in tools like [Spinach](https://github.com/codegram/spinach) and [Turnip](https://github.com/jnicklas/turnip).

This is an alpha release of Lucid as it strives to become its own entity in the world of BDD tools.


Installation
------------

Add this line to your application's Gemfile:

    gem 'lucid'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install lucid


Using Lucid
-----------

Much more detail on how to use Lucid will be coming soon. One way to get started however is to use the Lucid project generator. If you wanted to create a project directory called 'tutorial' for example, you could do this:

    $ lucid-gen project tutorial

In order to to check what options are available to you from the command line, do this:

    $ lucid --help

You should also check out some of my [blog posts related to Lucid](http://testerstories.com/category/lucid/). They will take you through various aspects of using the framework.


Contributing
------------

[Suggest an Improvement](https://github.com/jnyman/lucid/issues) or [Report a Bug](https://github.com/jnyman/lucid/issues)

To work on Lucid:

1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
2. Create a feature branch. (`git checkout -b my-new-feature`)
3. Commit your changes. (`git commit -am 'new feature'`)
4. Push the branch. (`git push origin my-new-feature`)
5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).