docs: update CONTRIBUTING.md

This commit is contained in:
Jake Wiesler 2020-06-17 08:53:04 -04:00
parent fdcf780d31
commit 6ec926aa2e
1 changed files with 4 additions and 11 deletions

View File

@ -10,17 +10,8 @@ First off, thank you for your time and effort! This project is not very large an
## Getting started
The first thing you'll want to do is clone the repository:
```bash
# https
git clone https://github.com/jakewies/hugo-theme-codex.git
# ssh
git clone git@github.com:jakewies/hugo-theme-codex.git
```
Next, you'll want to install dependencies with `yarn`:
1. Fork and clone the repository
2. Install dependencies:
```bash
cd hugo-theme-codex
@ -28,6 +19,8 @@ cd hugo-theme-codex
yarn install
```
## Scripts
There are 3 npm scripts that can be used for development purposes:
```bash