Permalink
Browse files

Adding readme

  • Loading branch information...
a-musing-moose committed Jan 3, 2011
1 parent a953bdb commit 2dd7ac760d72e5b31863be52eaf104b67d6031d4
Showing with 21 additions and 0 deletions.
  1. 0 README
  2. +21 −0 README.md
View
0 README
No changes.
View
@@ -0,0 +1,21 @@
+# Wotsit - A Bayesian Filtering Library for PHP
+
+## Installation
+
+### Install PHPUnit
+ sudo pear channel-discover pear.phpunit.de
+ sudo pear install phpunit/PHPUnit
+
+### Install Phing
+ sudo pear channel-discover pear.phing.info
+ sudo pear install phing/phing
+
+
+### Building
+Wotsit is designed to be packaged as a phar file. To create the package run:
+ phing build-all
+This will build run all tests, create documentation (in the /docs folder) and creates the Wotsit.phar file
+
+## Usage
+See documentation which can be build by running:
+ phing api-docs

0 comments on commit 2dd7ac7

Please sign in to comment.