-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
include development and installation information in README
- Loading branch information
1 parent
edeb078
commit 6218c76
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |