Skip to content

Commit

Permalink
Merge pull request #33 from autyzm-pg/Add_contributing_md
Browse files Browse the repository at this point in the history
Add contributing md
  • Loading branch information
mikolevy authored Oct 11, 2016
2 parents 2b448f1 + c180d36 commit a54b7b1
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#Contributing to Friendly Plans Link.
##About
Friendly Plans Link is an application to connect Friendly Plan ([GitHub](https://github.com/autyzm-pg/friendly-plans)) with computer. It provides functionality like backup and restore schedules what is an improvement required for better usability of Friendly Plan. The app supports autism treatment. More information and explanation shows the websites:

- About the treatment (ENG) http://www.pcdi.org/resources/videos.html
- Friendly Plan application in google play store: https://play.google.com/store/apps/details?id=com.przyjaznydamianek&hl=pl
- Project's website (PL): http://autyzm.eti.pg.gda.pl/
- Film shows the usage of Friendly Plans: https://www.youtube.com/watch?v=zI0ma_XnmCc

The Friendly Plans Link project was started by the community of Code for Poland http://kodujdlapolski.pl/

##License
The project is developing by people who want to make other people's life easier, so Friendly Plans Link is going to be free to use, download and develop for everybody forever. The license is GPL 3.0.

##Join
If you would like to be a part of community, you are welcome to join and contribute. Your help is needed. It is easy to contact by project's forum: http://autyzm.eti.pg.gda.pl/forum/ or by conversations in issues. Please use English, we are working on translations from Polish to English.
##Workflow

Current workflow for project is github-flow. Please make pull requests to master branch.
##Start

Start requires tablet with android, where Friendly Plan application is installed. Then clone the repo and open project in IDE. The app still requires android daemon or android sdk installed(light version for daemon could be download [here](
http://forum.xda-developers.com/showthread.php?t=2317790)) is also requires to set developers options on tablet. Run it like normal desktop application, connect tablet to computer, it should work!

0 comments on commit a54b7b1

Please sign in to comment.