/showcase

Simple display case for images like a portfolio or mockups

Primary LanguageJavaScriptMIT LicenseMIT

Showcase, Simple display case for images. 
==========================================

Showcase is a simple image display case for images. It can be used for many things, we at DigitPaint
use it to quickly put up series of website mockup images to show to our clients. Some of our designer friends 
use it to present rough sketches of their work to their clients. 

Showcase isn't fancy but it:
* Does not require serverside scripting (so you can just FTP it to your favorite host and it works)
* Is very lightweight (packed with YUI Compressor it's about 30kB)
* Degrades nicely on older browsers (even your aunt with her 486 PC and Internet Explorer 4 
  can see the images (not tested though))
* Is very easy to set up even without a lot HTML knowledge
* It's very customizable (see the stylesheet and just hack away)

Get started
===========
On Apple OS X >= 10.4 or any other system that has ruby and rubygems installed:

1. Open a terminal and run "sudo gem install flurin-showcase --source=http://gems.github.com"
2. Now run "showcase <targetdirectory>"
3. Showcase should now have created a sample directory: add images to index.html at will. 
4. Upload the whole directory to a host of your choice.

A downloadable zip version that doesn't require ruby and works cross platform will be available shortly.

Some notes
==========

* Customize the <title></title> tag and the Showcase title: <h1 id="showcase-title"></h1>
* It's best to leave all the ID's of the HTML tags intact, stuff might break if they are changed.
* Add a "alt" attribute to images to have them displayed in the navigation bar
* You can add images at will, keep in mind that you should not add images that are too big, they
  won't work very well on the internet because of long load times.


For developers
==============
Currently only tested on OS X 10.4, requires rake. A pre-built package will be available
for download later on.

1. Clone this repository to your local computer
2. (Optional) Download YUI Compressor 2.5.3 from http://www.julienlecomte.net/yuicompressor/ and put
   the yuicompressor-2.3.5.jar in the vendor directory
3. Type "rake build"
4. Open build/index.html with your browser to see the sample showcase
5. Add images to build/images and insert them into index.html (Just leave the ids on the H1 and the DIV)
6. Upload to your favorite host


Copyright & license
===================

Copyright (c) 2008 Flurin Egger, DigitPaint, MIT Style License. (see MIT-LICENSE)