Skip to content

Commit

Permalink
Add CONTRIBUTE and INSTALL file
Browse files Browse the repository at this point in the history
  • Loading branch information
m19c committed Feb 3, 2014
1 parent dbc840f commit fedd7ec
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Awesome! You want to help us! It is also necessary for us to get help from our community. So we prepared this file to
give you a short introduction!

# Report a bug
1. Check if the issue has already been reported.
2. Try to isolate the problem.
3. Report your issue using the template below.

## Summary
Describe your problem.

## Information
Readium Version: e.g. 1.2.1
Browser: e.g. Chrome 30
OS: e.g. OSX

# Implement features
You can also implement great features and send a pull request instead. Follow the steps in the file `INSTALL.md` to get
`readium` work.
6 changes: 6 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Get it work
To get the dev environment working you simply need to run `make`. Once, this is done you can access our `grunt` commands:

- collect
- listen
- build

0 comments on commit fedd7ec

Please sign in to comment.