summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorctrlaltca <ctrlaltca@gmail.com>2014-10-10 08:17:59 +0200
committerctrlaltca <ctrlaltca@gmail.com>2014-10-10 08:17:59 +0200
commit34ef99f5e989a9fb24b451a3956bc6cf46c6a13f (patch)
tree565c1856e8aed8c0e690d836ee265493404ed8c7 /README.md
parent11ed5a16acb699d24c6fa0e71a675695703becb9 (diff)
parentf85cff4d1c95c5ffb0c0722ba97661be34cca083 (diff)
Merge pull request #536 from primetimesolutions/feature/readme_additions
added sections for demo, testing and contributing
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7c07b079..e5e61e84 100644
--- a/README.md
+++ b/README.md
@@ -45,3 +45,73 @@ Then you can include the autoloader, and you will have access to the library cla
<?php
require 'vendor/autoload.php';
```
+## Demo Apps
+The Demos folder has several different example prado applications. You can see more information about these applications here: http://www.pradosoft.com/demos/ . When you create your own prado application you do NOT need these folders.
+
+* address-book
+* blog
+* blog-tutorial
+* chat
+* composer
+* currency-converter
+* helloworld
+* northwind-db
+* personal
+* quickstart
+* soap
+* sqlmap
+* time-tracker
+
+
+## Testing
+
+Prado uses phpunit (https://phpunit.de/) for testing, phing (http://www.phing.info/) for building, and Selenum (http://www.seleniumhq.org/) for web browser emulation.
+
+Running `phing` with no arguments will show you the different tests/builds that are setup in build.xml.
+
+```
+$phing
+Buildfile: /yourcodepath/build.xml
+
+prado > help:
+
+ [echo]
+
+ Welcome to use PRADO build script!
+ ----------------------------------
+ You may use the following command format to build a target:
+
+ phing <target name>
+
+ where <target name> can be one of the following:
+
+ For all PRADO developers:
+ - test : run unit tests (results are under /build/test-reports)
+ - coverage : run unit tests collecting coverage informations
+ - lint : run lint on framework
+ - lint-demos : run lint on demos
+```
+
+
+## Contributing
+
+In the spirit of free software, **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting bugs
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving issues
+* by reviewing patches
+
+Starting point:
+
+* Fork the repo
+* Clone your repo
+* Make your changes
+* Write tests for your changes to ensure that later changes to prado won't break your code.
+* Submit your pull request
+