Browse Source

Add README files to top level of each subtree split.

mark_story 13 years ago
parent
commit
3448a2dee6
2 changed files with 47 additions and 0 deletions
  1. 13 0
      App/README.md
  2. 34 0
      lib/README.md

+ 13 - 0
App/README.md

@@ -0,0 +1,13 @@
+# CakePHP Application Skeleton
+
+A skeleton for creating applications with [CakePHP](http://cakephp.org).
+
+## Installation
+
+You can install this application skeleton using composer. You'll need to install
+[composer](http://getcomposer.org/doc/00-intro.md) first. After installing `composer`
+you can install this project & the required dependencies using:
+
+	php composer.phar create-project cakephp/cakephp-app --dev
+
+This will download this repository, install the CakePHP framework and testing libraries.

+ 34 - 0
lib/README.md

@@ -0,0 +1,34 @@
+# CakePHP framework
+
+[![CakePHP](http://cakephp.org/img/cake-logo.png)](http://www.cakephp.org)
+
+CakePHP is a rapid development framework for PHP which uses commonly known
+design patterns like Active Record, Association Data Mapping, Front Controller
+and MVC.  Our primary goal is to provide a structured framework that enables
+PHP users at all levels to rapidly develop robust web applications, without any
+loss to flexibility.
+
+## Installing CakePHP via composer
+
+You can install CakePHP into your project using
+[composer](http://getcomposer.org).  If you're starting a new project, we
+recommend using the [app skeleton](https://github.com/cakephp/cakephp-app) as
+a starting point. For existing applications you can add the following to your
+`composer.json` file:
+
+	"require": {
+		"cakephp/framework": "dev-3.0"
+	}
+
+And run `php composer.phar update`
+
+Some Handy Links
+----------------
+
+* [CakePHP](http://www.cakephp.org) - The rapid development PHP framework
+* [Cookbook](http://book.cakephp.org) - THE Cake user documentation; start learning here!
+* [Plugins](http://plugins.cakephp.org/) - A repository of extensions to the framework
+* [The Bakery](http://bakery.cakephp.org) - Tips, tutorials and articles
+* [API](http://api.cakephp.org) - A reference to Cake's classes
+* [CakePHP TV](http://tv.cakephp.org) - Screen casts from events and video tutorials
+* [The Cake Software Foundation](http://cakefoundation.org/) - promoting development related to CakePHP