1
0
Fork 0
composer/README.md

82 lines
2.7 KiB
Markdown
Raw Normal View History

2011-04-05 15:36:01 +00:00
Composer - Package Management for PHP
=====================================
2011-10-02 21:38:27 +00:00
Composer is a package manager tracking local dependencies of your projects and libraries.
2011-04-05 15:36:01 +00:00
2011-10-02 21:38:27 +00:00
See the [about page](http://packagist.org/about) on [packagist.org](http://packagist.org/) for more information.
2011-11-16 12:54:17 +00:00
[![Build Status](https://secure.travis-ci.org/composer/composer.png)](http://travis-ci.org/composer/composer)
2011-10-02 21:38:27 +00:00
Installation / Usage
--------------------
2011-10-23 17:39:49 +00:00
1. Download the [`composer.phar`](http://getcomposer.org/composer.phar) executable
2011-10-03 08:49:23 +00:00
2. Create a composer.json defining your dependencies. Note that this example is
2011-10-02 21:38:27 +00:00
a short version for applications that are not meant to be published as packages
themselves. To create libraries/packages please read the [guidelines](http://packagist.org/about).
``` json
{
"require": {
"monolog/monolog": ">=1.0.0"
}
}
```
2011-10-03 08:49:23 +00:00
3. Run Composer: `php composer.phar install`
4. Browse for more packages on [Packagist](http://packagist.org).
2011-04-05 15:36:01 +00:00
Installation from Source
------------------------
To run tests, or develop Composer itself, you must use the sources and not the phar
file as described above.
1. Run `git clone https://github.com/composer/composer.git`
2. Download the [`composer.phar`](http://getcomposer.org/composer.phar) executable
3. Run Composer to get the dependencies: `php composer.phar install`
Global installation of composer
-------------------------------
Since composer works with the current working directory it is possible to install it
in a system wide way.
1. Change into a directory in your path like `cd /usr/local/bin`
2. Get composer `wget http://getcomposer.org/composer.phar`
3. Make the phar executeable `chmod a+x composer.phar`
3. Change into a project directory `cd /path/to/my/project`
4. Use composer as you normally would `composer.phar install`
2011-10-23 17:39:49 +00:00
Contributing
------------
All code contributions - including those of people having commit access -
must go through a pull request and approved by a core developer before being
merged. This is to ensure proper review of all the code.
Fork the project, create a feature branch, and send us a pull request.
2011-04-05 15:36:01 +00:00
Requirements
------------
2011-10-02 21:38:27 +00:00
PHP 5.3+
Authors
-------
2011-04-05 15:36:01 +00:00
Nils Adermann - <naderman@naderman.de> - <http://twitter.com/naderman> - <http://www.naderman.de><br />
2011-04-16 12:42:35 +00:00
Jordi Boggiano - <j.boggiano@seld.be> - <http://twitter.com/seldaek> - <http://seld.be><br />
2011-06-28 18:37:31 +00:00
See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project.
2011-04-05 15:36:01 +00:00
License
-------
Composer is licensed under the MIT License - see the LICENSE file for details
2011-10-23 17:39:49 +00:00
Acknowledgments
---------------
2011-10-02 21:38:27 +00:00
This project's Solver started out as a PHP port of openSUSE's [Libzypp satsolver](http://en.opensuse.org/openSUSE:Libzypp_satsolver).