Project description

The goal of polished is to show the awesome progression and amount of tweaks that go into any website. My [resume](http://ericcarmichael.com)is a good example, dozens of hours of work and tweaking to come up with this pretty basic final product. Showing thatblood, sweat and hilarious tears in between should be pretty entertaining. Watch pages undulate, stretch, break,grow, and shrink into place.

### How does polished work?

1. Fires up selected backend *(for example, PelicanBackend if you use the [Pelican](https://github.com/getpelican/pelican) blog site generator)*2. Gets the git revision history3. Iterates through that history, prepares the page, screen caps it4. Converts images to video5. OPTIONALLY: If after reviewing the images/video you find bugs, inherit a backend and `@polish` out the kinks so it's a nice smooth video

Getting started===============

### Installing

**Requirements**

1. Mac/Linux1. NodeJS2. PhantomJS3. ffmpeg

Then

```> pip install polished```

### Usage

For a static website with no .html generation needed and `index.html` is in the same dir:

The default backend is `SimpleBackend` which (with no path specified) looks for "index.html" in current directory andexpects static html without any steps needed to generate the page. This default setup probably doesn't work for mostprojects.