Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 71 lines (49 sloc) 2.735 kb
7d4c0a9 Adding what is required to compile this page.
Divya Manian authored
1 ## Before you begin
2
3 1. Install Node (with npm): http://nodejs.org/#download
4 2. Install Sass: http://sass-lang.com/download.html
5 3. Optionally, install Compass: http://compass-style.org/
6
7 ## Getting Started
7017703 @connor adjust README to make how to help more clear
connor authored
8
1037dfe Updating with info on shell script for markdown generation.
Divya Manian authored
9 1. In your terminal, navigate to this project and type:
7017703 @connor adjust README to make how to help more clear
connor authored
10 ```
c48382a @paulirish renaming some titles.
paulirish authored
11 npm install .
7017703 @connor adjust README to make how to help more clear
connor authored
12 ```
6cf9fda formatting
Divya Manian authored
13
1037dfe Updating with info on shell script for markdown generation.
Divya Manian authored
14 2. To generate the index.html page, type:
7017703 @connor adjust README to make how to help more clear
connor authored
15 ```
16 node .
17 ```
2e34de4 Updating readme about checkurls argument to be passed for production use...
Divya Manian authored
18 3. *Important Note*: To check if the urls are accurate (and for deploying to production), type:
19 ```
20 node . checkurls
21 ```
6cf9fda formatting
Divya Manian authored
22
2e34de4 Updating readme about checkurls argument to be passed for production use...
Divya Manian authored
23 4. Each of the features requires its own markdown file under `posts` folder. It is easy to create using the shell script on the parent directory. Just type `./new_feature.sh` and start entering details about the feature you want to add.
1037dfe Updating with info on shell script for markdown generation.
Divya Manian authored
24
2e34de4 Updating readme about checkurls argument to be passed for production use...
Divya Manian authored
25 5. All styles must be in the included `Sass` file rather than be updated in the generated CSS file. Easiest way to compile them is to use [Compass](http://compass-style.org/):
7017703 @connor adjust README to make how to help more clear
connor authored
26 ```
27 compass watch .
28 ```
29
30 ## Changelog
31
c307a35 Update readme.md
Divya Manian authored
32 ### Dec 12 2011
9fed738 New workflow, working with markdown files - one per feature. To make thi...
Divya Manian authored
33
34 - No more JSON!
35 - Now we create each 'feature' with a markdown file that has YAML-like front matter. To make this easy, there is a `new_feature.sh` script that you can run to automate the creation of the file for each feature that needs to be written about. e.g. you would do `./new_feature.sh` and then enter "text-shadow" if you want to create a markdown file for the text-shadow feature. There is a `test.md` if you want to refer to (but really the shell script should do all the prompting for you to get set up). It even starts your default editor for you with the newly created file if you have the $EDITOR set up in your PATH.
36 - `features.json` is retired, only to be used for reference at best (as if its any useful).
37 - Plan is to port content directly from the modernizr wiki for now, link to caniuse data for more info.
38 - Likely, the templates might change in the meanwhile, I welcome your feedback on this setup. If you have better ideas, lemme know!
39
40 So new workflow for adding content here would be to run `./new_feature.sh`. But everything else remains the same.
41
c307a35 Update readme.md
Divya Manian authored
42 ### Nov 7 2011
f1c782d first decent site with json feed
Divya Manian authored
43
7017703 @connor adjust README to make how to help more clear
connor authored
44 Branch now uses node and compass!
f1c782d first decent site with json feed
Divya Manian authored
45
c307a35 Update readme.md
Divya Manian authored
46 ### July 9 2011
f1c782d first decent site with json feed
Divya Manian authored
47 A very basic idea of how this would look like. Lame filters and colors. See: http://dl.dropbox.com/u/952/gfs/index.html
48
49 "How do I use prefixes" would link to:
50
51 1. Where all prefixes occur (css properties, values, DOM interfaces).
52 2. How to use modernizr's prefix-returning function for use in your script.
53 3. A reduced snippet from there?
54 4. Graceful degradation guidelines
55 5. Link to Tantek wiki page on why we have prefixes (and when we wont have them).
56
57
58 "Tools for Feature Support":
59
60 1. Css3please.com
61 2. modernizr polyfill wiki
62 3. modernizr
63 4. CSS Preprocessors?
64 5. caniuse.com?
65
66
67 Context
68 ------
69 Started at: http://oksoclap.com/gfs
70
Something went wrong with that request. Please try again.