Actions

Framework

Difference between revisions of "Home"

From Joomla! Documentation

m (saving to preserve the markdown to mediawiki markup)
m (updates)
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{:{{FULLPAGENAME}}/header}}__NOTOC__
+
{{:{{FULLPAGENAME}}/header}}
<markdown>
+
<div style="float:right; padding-left:15px;"><markdown>
 
[![Build Status](https://travis-ci.org/joomla/joomla-framework.png?branch=master)](https://travis-ci.org/joomla/joomla-framework)
 
[![Build Status](https://travis-ci.org/joomla/joomla-framework.png?branch=master)](https://travis-ci.org/joomla/joomla-framework)
</markdown>
+
</markdown></div>
 
== What is the Joomla Framework ? ==
 
== What is the Joomla Framework ? ==
 
+
__TOC__
 
The <code>Joomla Framework</code> is a platform for writing web and command line applications in PHP. It is free and open source software, distributed under the GNU General Public License version 2 or later.
 
The <code>Joomla Framework</code> is a platform for writing web and command line applications in PHP. It is free and open source software, distributed under the GNU General Public License version 2 or later.
  
Line 11: Line 11:
 
For news and information about developering with Joomla, please visit http://developer.joomla.org.
 
For news and information about developering with Joomla, please visit http://developer.joomla.org.
  
View the Joomla Framework API Documentation at http://joomla.github.com/joomla-framework. Powered by [http://www.phpdoc.org phpDocumentor 2].
+
View the Joomla Framework API Documentation at http://joomla.github.io/joomla-framework. Powered by [http://www.phpdoc.org phpDocumentor 2].
  
You can discuss Joomla Framework development by joining the mailing list at http://groups.google.com/group/joomla-dev-platform.
+
You can discuss Joomla Framework development by joining the mailing list at http://groups.google.com/group/joomla-dev-framework.
  
 
== Requirements ==
 
== Requirements ==
Line 31: Line 31:
 
* Download Composer
 
* Download Composer
  
<code>curl -sS https://getcomposer.org/installer | php</code>
+
<code>curl -sS <nowiki>https://getcomposer.org/installer</nowiki> | php</code>
  
 
* Install the Joomla Framework
 
* Install the Joomla Framework
Line 39: Line 39:
 
=== Via Git ===
 
=== Via Git ===
  
<code>git clone git://github.com/joomla/joomla-framework.git</code>
+
<code><nowiki>git clone git://github.com/joomla/joomla-framework.git</nowiki></code>
  
 
== Documentation ==
 
== Documentation ==
  
General documentation about the Joomla Platform can be found under the [[docs/|/docs]] folder of this repository. In addition, each package has documentation in a <code>README.md</code> file.
+
General documentation about the Joomla Platform can be found under the [https://github.com/joomla/joomla-framework/tree/master/docs /docs] folder of the Git repository. In addition, each package has documentation in a <code>README.md</code> file.
  
 
== Reporting Bugs and Issue ==
 
== Reporting Bugs and Issue ==
Line 51: Line 51:
 
== Contributing ==
 
== Contributing ==
  
All kind of contributions are welcome. Please read about how to contribute [[CONTRIBUTING.markdown|here]].
+
All kind of contributions are welcome. Please read about how to contribute [https://github.com/joomla/joomla-framework/blob/master/CONTRIBUTING.markdown here].
  
 
You may find tasks you can do on the [https://github.com/joomla/joomla-framework/issues Issues] list by filtering on labels and milestones
 
You may find tasks you can do on the [https://github.com/joomla/joomla-framework/issues Issues] list by filtering on labels and milestones
 +
 +
[[Category:Joomla! Framework]]

Revision as of 23:24, 31 August 2013


Build Status

What is the Joomla Framework ?

Contents

The Joomla Framework is a platform for writing web and command line applications in PHP. It is free and open source software, distributed under the GNU General Public License version 2 or later.

It is comprises code originally developed for the Joomla Content Management System (CMS). For more information about the Joomla CMS visit http://www.joomla.org/about-joomla.html.

For news and information about developering with Joomla, please visit http://developer.joomla.org.

View the Joomla Framework API Documentation at http://joomla.github.io/joomla-framework. Powered by phpDocumentor 2.

You can discuss Joomla Framework development by joining the mailing list at http://groups.google.com/group/joomla-dev-framework.

Requirements

  • PHP 5.3.10

Installation

Via Composer

  • Create a project and add a composer.json file to it with the content :
{
    "require": {
        "joomla/joomla-framework": "dev-master"
    }
}
  • Download Composer

curl -sS https://getcomposer.org/installer | php

  • Install the Joomla Framework

php composer.phar install

Via Git

git clone git://github.com/joomla/joomla-framework.git

Documentation

General documentation about the Joomla Platform can be found under the /docs folder of the Git repository. In addition, each package has documentation in a README.md file.

Reporting Bugs and Issue

Bugs and issues found in the Joomla Framework code can be reported on the Issues list.

Contributing

All kind of contributions are welcome. Please read about how to contribute here.

You may find tasks you can do on the Issues list by filtering on labels and milestones