From 62a416bd5cd8a9f9fd7373aae1ff0a0ae1f70f62 Mon Sep 17 00:00:00 2001 From: Mattias Erming Date: Thu, 31 Jul 2014 13:15:41 +0200 Subject: [PATCH] Update README.md --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index df8581e..e7b204a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Boilerplate theme [![NPM version](https://badge.fury.io/js/jsonresume-theme-boilerplate.png)](https://www.npmjs.org/package/jsonresume-theme-boilerplate) +# Boilerplate theme [![](https://badge.fury.io/js/jsonresume-theme-boilerplate.png)](https://www.npmjs.org/package/jsonresume-theme-boilerplate) This is the boilerplate theme for [JSON Resume](http://jsonresume.org/). @@ -6,13 +6,13 @@ This is the boilerplate theme for [JSON Resume](http://jsonresume.org/). To get started with theme development, this is what you'll need: -- [node.js](http://http://howtonode.org/how-to-install-nodejs) +- [node.js](http://howtonode.org/how-to-install-nodejs) - [npm](http://howtonode.org/introduction-to-npm) If you're on Linux, you can simply run: ``` -apt-get install nodejs-legacy npm +sudo apt-get install nodejs-legacy npm ``` Or if you're on OSX and got [Homebrew](http://brew.sh/) installed: @@ -20,15 +20,52 @@ Or if you're on OSX and got [Homebrew](http://brew.sh/) installed: brew install node ``` -### Installing the command line +### Install the command line + +We're going to use the official [resume-cli](https://github.com/jsonresume/resume-cli) to run our development server. -We're going to use [resume-cli](https://github.com/jsonresume/resume-cli) to run our development server. Go ahead and install it: ``` -npm install -g resume-cli +sudo npm install -g resume-cli ``` +### Download theme + +Lets go ahead and clone the repository: + +``` +git clone http://github.com/jsonresume/jsonresume-theme-boilerplate +``` + +### Install npm packages + +We need to install the dependencies. `cd` into the theme folder and run: + +```bash +sudo npm install +``` + +This will read the local `package.json` and install the packages listed under `dependencies`. + +### Serve theme + +While inside the theme folder, simply run: + +``` +resume serve +``` + +If successful, you should now see this message: + +``` +Preview: http://localhost:4000 +Press ctrl-c to stop +``` + +Congratulations, you've made it! +__The theme development can now begin.__ + ## License Available under [the MIT license](http://mths.be/mit).