Files
jsonresume-theme-short/README.md
Mattias Erming 62a416bd5c Update README.md
2014-07-31 04:18:01 -07:00

1.5 KiB

Boilerplate theme

This is the boilerplate theme for JSON Resume.

Getting started

To get started with theme development, this is what you'll need:

If you're on Linux, you can simply run:

sudo apt-get install nodejs-legacy npm

Or if you're on OSX and got Homebrew installed:

brew install node

Install the command line

We're going to use the official resume-cli to run our development server.

Go ahead and install it:

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:

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.