|
1 | | -The h5bp build script now has three versions, the main one being |
2 | | -the [ant-build-script][]. This |
3 | | -project is the node version, and it uses [Grunt][grunt] as a build tool. |
| 1 | +# This project has been sunsetted. |
4 | 2 |
|
5 | | -It is packaged as a [grunt plugin](https://github.com/gruntjs/grunt/wiki/Creating-plugins) and provides you a bunch of tasks and |
6 | | -helpers to help improve the performance of your site/app in a production |
7 | | -environment. |
| 3 | +Currently we don't maintain this project anymore and would advice you to not use |
| 4 | +it anymore. |
8 | 5 |
|
9 | | -## Description |
| 6 | +Please check out [Yeoman](http://yeoman.io/) which helps you scaffolding your |
| 7 | +project. |
10 | 8 |
|
11 | | -This node/grunt-based build script tries to be as close as possible to |
12 | | -the [ant-build-script][], a really great project you should check out. |
13 | | - |
14 | | -It is still in early stage of development, but will get better, thanks to [your feedback](https://github.com/h5bp/node-build-script/issues). |
15 | | - |
16 | | -## Quick start |
17 | | - |
18 | | -**Fancy one line install:** |
19 | | - |
20 | | -```sh |
21 | | -# see the gist: https://gist.github.com/2359881 |
22 | | -$ curl https://raw.github.com/gist/2359881/install.sh | sh |
23 | | -``` |
24 | | - |
25 | | -**Slightly less fancier** |
26 | | - |
27 | | -```sh |
28 | | -$ npm install http://github.com/h5bp/node-build-script/tarball/master -g |
29 | | -$ h5bp help |
30 | | -$ h5bp init |
31 | | -``` |
32 | | - |
33 | | -**Developing locally** |
34 | | - |
35 | | -```sh |
36 | | -$ git clone git://github.com/h5bp/node-build-script.git |
37 | | -$ cd node-build-script |
38 | | -$ npm link |
39 | | -``` |
40 | | - |
41 | | -## Features |
42 | | - |
43 | | -* Concats / Compresses JS |
44 | | -* Concats / Compresses CSS |
45 | | -* Inline CSS imports via RequireJS |
46 | | -* Basic to aggressive html minification (via [html-minfier][]) |
47 | | -* Optimizes JPGs and PNGs (with jpegtran & optipng) |
48 | | -* Renames JS/CSS to prepend a hash of their contents for easier versioning |
49 | | -* Revises the file names of your assets so that you can use heavy caching |
50 | | -* Updates your HTML to reference these new hyper-optimized CSS + JS files |
51 | | -* Experimental dom-based (with [JSDOM]()) build system. |
52 | | -* May rerun the build script on file changes (grunt's watch task ❤) |
53 | | -* May automatically reload the page in your browsers whenever watched files |
54 | | - change, through some [socket.io] magic. |
55 | | - |
56 | | -## Getting started |
57 | | - |
58 | | -* [Install](https://github.com/h5bp/node-build-script/wiki/install) the package |
59 | | -* Check out the extensive [grunt documentation](https://github.com/gruntjs/grunt/blob/master/README.md), specifically the |
60 | | - [Getting Started](https://github.com/gruntjs/grunt/wiki/Getting-started) section. |
61 | | -* Learn more about [Usage](https://github.com/h5bp/node-build-script/wiki/overview) |
62 | | - and [Configuration](https://github.com/h5bp/node-build-script/wiki/configuration) |
63 | | -* Look at the [available tasks](https://github.com/h5bp/node-build-script/wiki/tasks) |
64 | | -* Test out the experimental |
65 | | - [dom-based](https://github.com/h5bp/node-build-script/wiki/dom) build |
66 | | - system. |
67 | | - |
68 | | -## Project information |
69 | | - |
70 | | -* Source: http://github.com/h5bp/node-build-script |
71 | | -* Docs: http://github.com/h5bp/node-build-script/wiki |
72 | | -* Issues: http://github.com/h5bp/node-build-script/issues |
73 | | - |
74 | | -## Run the tests |
75 | | - |
76 | | -```sh |
77 | | -$ npm test |
78 | | -``` |
79 | | - |
80 | | -[grunt]: https://github.com/gruntjs/grunt |
81 | | -[grunt documentation]: https://github.com/gruntjs/grunt/blob/master/docs/toc.md |
82 | | -[grunt plugin]: https://github.com/gruntjs/grunt/blob/master/docs/plugins.md |
83 | | -[Getting Started]: https://github.com/gruntjs/grunt/blob/master/docs/getting_started.md#readme) |
84 | | -[JSDOM]: https://github.com/tmpvar/jsdom |
85 | | -[ant-build-script]: https://github.com/h5bp/ant-build-script |
86 | | -[socket.io]: http://socket.io |
87 | | -[html-minifier]: https://github.com/kangax/html-minifier |
| 9 | +The old readme file is [still available](documentation.md) though. |
0 commit comments