Browse files

Updated readme for grunt based build.

  • Loading branch information...
1 parent 784c30d commit 114d3fed0d7f5b78b98714585934f6ab6e990a88 @ahume ahume committed Jan 14, 2013
Showing with 17 additions and 11 deletions.
  1. +9 −11 README.md
  2. +8 −0 setup.sh
View
20 README.md
@@ -6,20 +6,18 @@ Pasteup is where design meets development. It is where the Guardian’s globally
**Why Pasteup?** It's a newspaper term for "the assemblage of pages by pasting type onto page mockups, which are then photographed to be made into metal plates for the printing press" (courtesy of John E McIntyre). This is quite a nice metaphor for how client-side development builds the Guardian's pages. Plus it sounds cool.
Getting started
----------------
+===============
- > ./setup.sh # Installs build/server dependencies, including nodejs and npm.
- > cd build
- > node server.js # Starts server on http://localhost:3000
+To build Pasteup you need the following installed:
-You should now be able to reach the docs homepage at http://localhost:3000/docs/index.html. Any changes you make in the `/less`, `/js`, or `/content` directories will trigger a full build, and immediatley be available for viewing on localhost.
+* nodejs
+* npm
+* grunt
-LESS
-----
+On linux you can run `> ./setup` to do this.
-Pasteup uses LESS to build and minify CSS. Sometimes, if you ask nicely you can use a CSS variable - or maybe even a mixin.
+With these dependencies installed try the following.
-RequireJS
----------
+`> grunt # Build Pasteup, starts server on localhost:3000 and watches files for changes.`
-Pasteup uses RequireJS and the AMD pattern to split JavaScript into modules, along with the built in optimizer to build production versions of these modules.
+`> grunt build # Runs the build.`
View
8 setup.sh
@@ -17,3 +17,11 @@ sudo make install
echo "Installing npm"
echo "==============================================="
curl -L http://npmjs.org/install.sh | sudo sh
+
+echo "Installing grunt"
+echo "==============================================="
+npm install -g grunt
+
+echo "Installing bower"
+echo "==============================================="
+npm install -g bower

0 comments on commit 114d3fe

Please sign in to comment.