Permalink
Browse files

update intro

  • Loading branch information...
1 parent 5ce930d commit c1a923d31db149d9a13885a676624485f1350e48 @c9s c9s committed Dec 26, 2011
Showing with 57 additions and 38 deletions.
  1. +49 −0 HACKING.md
  2. +8 −38 README.md
View
@@ -20,6 +20,17 @@ Pear Dependencies will be installed into vendor/pear/
Run `scripts/onion` can test onion application without re-compile it.
+
+## Structures
+
+CLI Application bootstrap is located at `scripts/onion`.
+
+Commands are registered in `src/Onion/Application.php`, this is where CLI application start.
+
+Commands are putted in src/Onion/Command/
+
+About GetOpt stuff, please see GetOptionKit.
+
## Unit Testing
Run `phpunit`.
@@ -31,3 +42,41 @@ Run `scripts/compile.sh`
## Release
Run `scripts/release.sh`
+
+
+## Reference
+
+INI format spec: <http://www.cloanto.com/specs/ini/>
+
+Package structure
+<http://pear.php.net/manual/en/pyrus.commands.make.php>
+
+
+package.xml 2.0 tags
+<http://pear.php.net/manual/en/guide.developers.package2.tags.php>
+
+
+package.xml dependency
+<http://pear.php.net/manual/en/guide.developers.package2.dependencies.php>
+
+
+PEAR2 Coding Standard
+<http://pear.php.net/manual/en/pear2cs.php>
+
+Pyrus
+<http://pear.php.net/manual/en/pyrus.php>
+
+PEAR
+<http://pear.php.net/manual/en/guide.users.concepts.php>
+<http://pear.php.net/manual/en/pyrus.extending.packagefile.php>
+<http://pear.php.net/manual/en/guide.users.dependencytracking.generatingpackagexml.php>
+
+PEAR Installer
+<http://pear.php.net/manual/en/developers-core.php>
+<http://pear.php.net/manual/en/developers-changes14.php>
+
+Deployment PEAR
+<http://www.eschrade.com/page/deployment-pear-4c228790/>
+
+PSR-0
+<https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md>
View
@@ -6,13 +6,21 @@ Onion, The fast approach to make/install packages for PHP.
Onion is able to generate a PEAR2-compatible package.xml file from a very simple config
file, you can release your PEAR package very quickly!
+And through Onion, you can also install PEAR dependencies into local bundle (just like Ruby Bundler).
+
Onion is not target to replace other package manager, its target is to make current PEAR ecosystem easier.
Let's keep hard long PEAR package.xml away! :-)
+
( We are still in development, patches, feature requests are welcome! This
utility is in alpha development, config spec might change. )
+## Onion is for people want to..
+
+* Build PEAR package easily, quickly.
+* Install PEAR dependencies into local project directory. (like Ruby Bundler)
+
## Requirement
* PHP 5.3
@@ -154,41 +162,3 @@ nrk:
## Community
If you have questions about Onion or want to help out, come and join us in the #onion-dev channel on `irc.freenode.net`.
-
-## Reference
-
-INI format spec: <http://www.cloanto.com/specs/ini/>
-
-Package structure
-<http://pear.php.net/manual/en/pyrus.commands.make.php>
-
-
-package.xml 2.0 tags
-<http://pear.php.net/manual/en/guide.developers.package2.tags.php>
-
-
-package.xml dependency
-<http://pear.php.net/manual/en/guide.developers.package2.dependencies.php>
-
-
-PEAR2 Coding Standard
-<http://pear.php.net/manual/en/pear2cs.php>
-
-Pyrus
-<http://pear.php.net/manual/en/pyrus.php>
-
-PEAR
-<http://pear.php.net/manual/en/guide.users.concepts.php>
-<http://pear.php.net/manual/en/pyrus.extending.packagefile.php>
-<http://pear.php.net/manual/en/guide.users.dependencytracking.generatingpackagexml.php>
-
-PEAR Installer
-<http://pear.php.net/manual/en/developers-core.php>
-<http://pear.php.net/manual/en/developers-changes14.php>
-
-Deployment PEAR
-<http://www.eschrade.com/page/deployment-pear-4c228790/>
-
-PSR-0
-<https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md>
-

0 comments on commit c1a923d

Please sign in to comment.