Readme updates
This commit is contained in:
17
README.md
17
README.md
@@ -1,23 +1,16 @@
|
|||||||
# Boilerplate theme [](https://www.npmjs.org/package/jsonresume-theme-boilerplate)
|
# Jsonresume Short Theme
|
||||||
|
|
||||||
This is the boilerplate theme for [JSON Resume](http://jsonresume.org/).
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
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://howtonode.org/how-to-install-nodejs)
|
- [node.js](http://howtonode.org/how-to-install-nodejs)
|
||||||
- [npm](http://howtonode.org/introduction-to-npm)
|
- yarn
|
||||||
|
|
||||||
If you're on Linux, you can simply run:
|
If you're on Arch Linux, you can simply run:
|
||||||
|
|
||||||
```
|
```
|
||||||
sudo apt-get install nodejs-legacy npm
|
sudo pacman -S yarn
|
||||||
```
|
|
||||||
|
|
||||||
Or if you're on OSX and got [Homebrew](http://brew.sh/) installed:
|
|
||||||
```
|
|
||||||
brew install node
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install the command line
|
### Install the command line
|
||||||
@@ -39,7 +32,7 @@ Lets go ahead and download a [copy of the repository](https://github.com/jsonres
|
|||||||
We need to install the dependencies. `cd` into the theme folder we just downloaded and run:
|
We need to install the dependencies. `cd` into the theme folder we just downloaded and run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo npm install
|
yarn global add $PWD
|
||||||
```
|
```
|
||||||
|
|
||||||
This will read the local `package.json` and install the packages listed under `dependencies`.
|
This will read the local `package.json` and install the packages listed under `dependencies`.
|
||||||
|
|||||||
Reference in New Issue
Block a user