README

Wink
====

Wink is a minimalists weblog engine written in Ruby using Rack, Sinatra, and
DataMapper. See the project repository on GitHub for more information:

http://github.com/rtomayko/wink/

Status
------

A complete mess, at the moment. It will likely not run for you at all. The
sources have been made available as-is for discussion purposes only. If you're
mainly interested in running a blog, watch for a 1.0 release. If you're
interested in hacking, stick around...

Requirements
------------

Gems (need all their dependencies of course):

    $ sudo gem install datamapper --version=0.2.5
    $ sudo gem install do_mysql
    $ sudo gem install sinatra BlueCloth rubypants html5 test-spec

To run the specs you also need SQLite3 and the SQLite3-adapter:
    $ sudo gem install do_sqlite3 --version=0.2.5

We are currently developing on MySQL and SQLite3. Other databases are
theoretically easy to support but we're limiting to these for now to speed
initial development.

Wink is developed primarily under MacOS X and tested on FreeBSD and
a variety of GNU/Linux distributions.

Hacking
-------

Project sources are stored in Git:

    $ git clone git://github.com/rtomayko/wink.git

Create a new MySQL database:

    $ mysql -u root
    mysql> CREATE DATABASE wink_development CHARACTER SET = utf8;

Next, change into your local wink clone and copy the `wink.conf.example`
to `wink.conf`; edit to taste, making sure the database related settings
are adjusted appropriately.

Run the `db:init` task to create the initial table schema and then start a new
development server:

    $ rake db:init
    $ ruby wink

The application should be available at: http://localhost:4567

Testing
-------

Unit and functional tests are kept under the test directory. Before running
tests, you will need to create a separate database:

    $ mysql -u root
    mysql> CREATE DATABASE wink_test CHARACTER SET = utf8;

Once the database has been created, use rake to run the test suite:

    $ rake test

COPYING
-------

All sources included in this distribution are made available under the MIT
license. See the file COPYING for more information.