Skip to content

Commit

Permalink
Add dev setup instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
zanedb committed Feb 25, 2019
1 parent 3be7a1c commit 3b8295e
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Expand Up @@ -22,3 +22,31 @@ export default () => (
</div>
)
```

## Development Setup

1. Clone & enter the repo.

```sh
$ git clone https://github.com/hackclub/icons.git
$ cd icons
```

2. Install dependencies.

```sh
$ npm install
```

3. Setup docs (optional, do this if you’ve added icons).

```sh
npm run prepare
npm run docs
```

4. Run locally.

```sh
npm run dev
```

0 comments on commit 3b8295e

Please sign in to comment.