alicia/jsonresume-theme-short
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mattias Erming
2014-07-31 13:15:41 +02:00
parent eb3cad7871
commit 62a416bd5c
1 changed files with 43 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -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/). 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: 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) - [npm](http://howtonode.org/introduction-to-npm)
If you're on Linux, you can simply run: 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: 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 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: 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 ## License
Available under [the MIT license](http://mths.be/mit). Available under [the MIT license](http://mths.be/mit).