Added README.

anatoo · Nov 23, 2012 · 9a9521c · 9a9521c
1 parent 1918937
commit 9a9521c
Show file tree

Hide file tree

Showing 29 changed files with 37 additions and 1 deletion.
diff --git a/README.markdown b/README.markdown
@@ -0,0 +1,36 @@
+PHPPEG
+====
+
+PEG Parser Combinator for PHP5.
+
+Install
+----
+
+Use [composer](http://getcomposer.org/) to install this library.
+
+    $ mkdir foobar && cd foobar
+    $ echo '{"require": {"phppeg/phppeg": "*"}}' >  composer.json
+    $ composer install
+
+And include "vendor/autoload.php" to setup auto-loading for PHPPEG in your code.
+
+    <?php
+    include_once __DIR__ . '/vendor/autoload.php';
+
+How to run tests and examples
+----
+
+Execute setup.sh after git-clone to setup auto-loading.
+
+    $ git clone https://github.com/anatoo/PHPPEG.git
+    $ cd PHPPEG
+    $ ./setup.sh
+
+Run all tests:
+
+    $ php test/t/testall.php
+
+Run examples:
+
+    $ php examples/example01.php
+
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
         }
     ],
     "autoload": {
-        "psr-0" : { "PEG": "code/" }
+        "psr-0" : { "PEG": "src/" }
     },
     "require": {
         "php": ">=5.2.0"

diff --git a/code/PEG.php → src/PEG.php b/code/PEG.php → src/PEG.php
diff --git a/code/PEG/Action.php → src/PEG/Action.php b/code/PEG/Action.php → src/PEG/Action.php
diff --git a/code/PEG/And.php → src/PEG/And.php b/code/PEG/And.php → src/PEG/And.php
diff --git a/code/PEG/Anything.php → src/PEG/Anything.php b/code/PEG/Anything.php → src/PEG/Anything.php
diff --git a/code/PEG/ArrayContext.php → src/PEG/ArrayContext.php b/code/PEG/ArrayContext.php → src/PEG/ArrayContext.php
diff --git a/code/PEG/Cache.php → src/PEG/Cache.php b/code/PEG/Cache.php → src/PEG/Cache.php
diff --git a/code/PEG/CallbackAction.php → src/PEG/CallbackAction.php b/code/PEG/CallbackAction.php → src/PEG/CallbackAction.php
diff --git a/code/PEG/Char.php → src/PEG/Char.php b/code/PEG/Char.php → src/PEG/Char.php
diff --git a/code/PEG/Choice.php → src/PEG/Choice.php b/code/PEG/Choice.php → src/PEG/Choice.php
diff --git a/code/PEG/Curry.php → src/PEG/Curry.php b/code/PEG/Curry.php → src/PEG/Curry.php
diff --git a/code/PEG/Delay.php → src/PEG/Delay.php b/code/PEG/Delay.php → src/PEG/Delay.php
diff --git a/code/PEG/EOS.php → src/PEG/EOS.php b/code/PEG/EOS.php → src/PEG/EOS.php
diff --git a/code/PEG/ErrorReporter.php → src/PEG/ErrorReporter.php b/code/PEG/ErrorReporter.php → src/PEG/ErrorReporter.php
diff --git a/code/PEG/Failure.php → src/PEG/Failure.php b/code/PEG/Failure.php → src/PEG/Failure.php
diff --git a/code/PEG/IContext.php → src/PEG/IContext.php b/code/PEG/IContext.php → src/PEG/IContext.php
diff --git a/code/PEG/IParser.php → src/PEG/IParser.php b/code/PEG/IParser.php → src/PEG/IParser.php
diff --git a/code/PEG/InstantParser.php → src/PEG/InstantParser.php b/code/PEG/InstantParser.php → src/PEG/InstantParser.php
diff --git a/code/PEG/Lookahead.php → src/PEG/Lookahead.php b/code/PEG/Lookahead.php → src/PEG/Lookahead.php
diff --git a/code/PEG/Many.php → src/PEG/Many.php b/code/PEG/Many.php → src/PEG/Many.php
diff --git a/code/PEG/Memoize.php → src/PEG/Memoize.php b/code/PEG/Memoize.php → src/PEG/Memoize.php
diff --git a/code/PEG/Not.php → src/PEG/Not.php b/code/PEG/Not.php → src/PEG/Not.php
diff --git a/code/PEG/Optional.php → src/PEG/Optional.php b/code/PEG/Optional.php → src/PEG/Optional.php
diff --git a/code/PEG/Ref.php → src/PEG/Ref.php b/code/PEG/Ref.php → src/PEG/Ref.php
diff --git a/code/PEG/Sequence.php → src/PEG/Sequence.php b/code/PEG/Sequence.php → src/PEG/Sequence.php
diff --git a/code/PEG/StringContext.php → src/PEG/StringContext.php b/code/PEG/StringContext.php → src/PEG/StringContext.php
diff --git a/code/PEG/Token.php → src/PEG/Token.php b/code/PEG/Token.php → src/PEG/Token.php
diff --git a/code/PEG/Util.php → src/PEG/Util.php b/code/PEG/Util.php → src/PEG/Util.php