From fea663d2233a773fab35162920e69f63d6a0d968 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=88=90=E6=AD=A6?= Date: Wed, 8 Jan 2014 01:15:01 +0800 Subject: [PATCH] update 01-basic-usage.md --- cn-introduction/01-basic-usage.md | 38 ++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/cn-introduction/01-basic-usage.md b/cn-introduction/01-basic-usage.md index bdac53e..7ddef0a 100644 --- a/cn-introduction/01-basic-usage.md +++ b/cn-introduction/01-basic-usage.md @@ -1,22 +1,24 @@ + # 基本用法 --- -- [基本用法](#基本用法) - - [安装](#安装) - - [`composer.json`：项目安装](#composerjson项目安装) - - [关于 `require` Key](#关于-require-key) - - [包名称](#包名称) - - [包版本](#包版本) - - [下一个重要版本（波浪号运算符）](#下一个重要版本波浪号运算符) - - [稳定性](#稳定性) - - [安装依赖关系](#安装依赖关系) - - [`composer.lock` - 锁文件](#composerlock---锁文件) - - [packagist](#packagist) - - [自动加载](#自动加载) +- [基本用法](#Basic usage) + - [安装](#Installation) + - [`composer.json`：项目安装](#composer.json Project Setup) + - [关于 `require` Key](#The require Key) + - [包名称](#Package Names) + - [包版本](#Package Versions) + - [下一个重要版本（波浪号运算符）](#Next Significant Release) + - [稳定性](#Stability) + - [安装依赖关系](#Installing Dependencies) + - [`composer.lock` - 锁文件](#composer.lock - The Lock File) + - [packagist](#Packagist) + - [自动加载](#Autoloading) --- + ## 安装 安装 Composer，你只需要下载 `composer.phar` 可执行文件。 @@ -37,12 +39,14 @@ > $ curl -sS https://getcomposer.org/installer | php -- --check > $ curl -sS https://getcomposer.org/installer | php -- --help + ## `composer.json`：项目安装 要开始在你的项目中使用 Composer，你只需要一个 `composer.json` 文件。该文件包含了项目的依赖和其它的一些元数据。 这个 [JSON format](http://json.org/) 是很容易编写的。它允许你定义嵌套结构。 + ### 关于 `require` Key 第一件事情（并且往往只需要做这一件事），你需要在 `composer.json` 文件中指定 `require` key 的值。你只需要简单的告诉 Composer 你的项目需要依赖哪些包。 @@ -55,12 +59,14 @@ 你可以看到， `require` 需要一个 **包名称** （例如 `monolog/monolog`） 映射到 **包版本** （例如 `1.0.*`） 的对象。 + ### 包名称 包名称由供应商名称和其项目名称构成。通常容易产生相同的项目名称，而供应商名称的存在则很好的解决了命名冲突的问题。它允许两个不同的人创建同样名为 `json` 的库，而之后它们将被命名为 `igorw/json` 和 `seldaek/json`。 这里我们需要引入 `monolog/monolog`，供应商名称与项目的名称相同，对于一个具有唯一名称的项目，我们推荐这么做。它还允许以后在同一个命名空间添加更多的相关项目。如果你维护着一个库，这将使你可以很容易的把它分离成更小的部分。 + ### 包版本 在前面的例子中，我们引入的 monolog 版本指定为 `1.0.*`。这表示任何从 `1.0` 开始的开发分支，它将会匹配 `1.0.0`、`1.0.2` 或者 `1.0.20`。 @@ -104,14 +110,17 @@ + ### 下一个重要版本（波浪号运算符） `~` 最好用例子来解释： `~1.2` 相当于 `>=1.2,<2.0`，而 `~1.2.3` 相当于 `>=1.2.3,<1.3`。正如你所看到的这对于遵循 [语义化版本号](http://semver.org/) 的项目最有用。一个常见的用法是标记你所依赖的最低版本，像 `~1.2` （允许1.2以上的任何版本，但不包括2.0）。由于理论上直到2.0应该都没有向后兼容性问题，所以效果很好。你还会看到它的另一种用法，使用 `~` 指定最低版本，但允许版本号的最后一位数字上升。 + ### 稳定性 默认情况下只有稳定的发行版才会被考虑在内。如果你也想获得 RC、beta、alpha 或 dev 版本，你可以使用 [稳定标志](04-schema.md#package-links)。你可以对所有的包做 [最小稳定性](04-schema.md#minimum-stability) 设置，而不是每个依赖逐一设置。 + ## 安装依赖关系 获取定义的依赖到你的本地项目，只需要调用 `composer.phar` 运行 `install` 命令。 @@ -127,6 +136,7 @@ 另一件事是 `install` 命令将创建一个 `composer.lock` 文件到你项目的根目录中。 + ## `composer.lock` - 锁文件 在安装依赖后，Composer 将把安装时确切的版本号列表写入 `composer.lock` 文件。这将锁定改项目的特定版本。 @@ -150,7 +160,8 @@ > **注意：** 对于库，并不一定建议提交锁文件 > 请参考：[库的锁文件](02-libraries.md#lock-file). -## packagist + +## Packagist [packagist](https://packagist.org/) 是 Composer 的主要资源库。 一个 Composer 的库基本上是一个包的源：记录了可以得到包的地方。Packagist 的目标是成为大家使用库资源的中央存储平台。这意味着你可以 `require` 那里的任何包。 @@ -158,6 +169,7 @@ 任何支持 Composer 的开源项目应该发布自己的包在 packagist 上。虽然并不一定要发布在 packagist 上来使用 Composer，但它使我们的编程生活更加轻松。 + ## 自动加载 对于库的自动加载信息，Composer 生成了一个 `vendor/autoload.php` 文件。你可以简单的引入这个文件，你会得到一个免费的自动加载支持。