diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..d35bcb1 --- /dev/null +++ b/CONTRIBUTE.md @@ -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. \ No newline at end of file diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..8d4eb65 --- /dev/null +++ b/INSTALL.md @@ -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 \ No newline at end of file