Skip to content

Commit

Permalink
include development and installation information in README
Browse files Browse the repository at this point in the history
  • Loading branch information
samgqroberts committed Jun 16, 2018
1 parent edeb078 commit 6218c76
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,35 @@
# Headmates
The goal of this project is to provide for the user as she writes in a textbox multiple suggestions for the next words / phrases.

# Development

## Installation
All steps should be taken from root directory of repository

### Install `npm`
Follow the instructions here: https://github.com/creationix/nvm
Any modern version of node and npm ought to work.

### Install Elm (importantly, `elm-package`)
`npm install -g elm`

### Install `elm-test`
`npm install -g elm-test`

### Install Elm dependencies
`elm-package install`

### Install `yarn`
`npm install -g yarn`

### Install `npm` dependencies
`yarn install`

## Development Environment
After installation, normal development involves the following.

### Running a local build, with webpack watching, recompilation, and auto-refresh of browser page
`yarn start`

### Running the tests in watch mode
`elm-test --watch`

0 comments on commit 6218c76

Please # to comment.