Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 53 lines (37 sloc) 1.661 kb
abd2833 @webandy initial commit
webandy authored
1 Spark is a simple HTML project generator
2
3 How to install
4 ===
5 `sudo gem install spark`
6
7 This will install a `spark` command line executable.
8
9 How to use
10 ===
11 Generate a HTML starter project in a directory called "foo":
12
13 spark foo
14
15 Or if you are already in the directory called "foo":
16
17 spark .
18
19 After running spark, you should see something like:
20
21 Successfully created the following:
22 foo
23 foo/js
24 foo/js/jquery-1.4.2.min.js
25 foo/js/application.js
26 foo/index.html
27 foo/css
28 foo/css/reset.css
29 foo/css/application.css
30
31
32 Options
33 ===
34 There aren't any options at this point, but the plan is to add configuration options in time to generate more files or less files, or generate different content within the files.
35
36 To verify spark is installed, type `spark -v` which should produce:
37
67e0360 @webandy update the version, add notes on aruba gem to Readme, update the spark v...
webandy authored
38 spark version 0.0.3
39
40 Testing
41 ===
42 If you want to develop for spark, please install the development dependencies. Spark is tested using Cucumber via the aruba gem. Please add tests for any new features added to spark.
abd2833 @webandy initial commit
webandy authored
43
44 Why?
45 ===
46 For sample projects I find myself creating the same HTML, CSS, and JS files over and over, adding jQuery, then linking everything up. This is a generator to save that repetitive typing. I also considered a simple github project that could be cloned, which would work fine too, but I'd like to make parts of this configurable in time.
47
48 The article titled [A simple Ruby command-line application skeleton](http://blog.infinitered.com/entries/show/5) was very helpful for this project.
49
50 Copyright
51 ===
52 Copyright (c) 2010 Andy Atkinson. Licensed under the MIT License:
53 http://www.opensource.org/licenses/mit-license.php
Something went wrong with that request. Please try again.