Browse Source

Added --prefer-dist to all docs

1. It results in much smaller download and takes less disk space (25MB instead of 180MB for yii-basic + dependencies).
2. It requires less utilities to be installed (no VCS binaries required).
3. It takes less time to install dependencies.
tags/2.0.0-beta
Alexander Makarov 11 years ago
parent
commit
dc45de127c
  1. 2
      apps/advanced/README.md
  2. 2
      apps/basic/README.md
  3. 2
      apps/benchmark/README.md
  4. 4
      docs/guide/apps-advanced.md
  5. 4
      docs/guide/apps-basic.md
  6. 4
      docs/guide/composer.md
  7. 2
      docs/guide/gii.md
  8. 2
      docs/guide/template.md
  9. 2
      docs/guide/view.md
  10. 3
      docs/internals/getting-started.md
  11. 2
      extensions/yii/apidoc/README.md
  12. 2
      extensions/yii/authclient/README.md
  13. 2
      extensions/yii/bootstrap/README.md
  14. 2
      extensions/yii/codeception/README.md
  15. 2
      extensions/yii/debug/README.md
  16. 2
      extensions/yii/elasticsearch/README.md
  17. 2
      extensions/yii/faker/README.md
  18. 2
      extensions/yii/gii/README.md
  19. 2
      extensions/yii/imagine/README.md
  20. 2
      extensions/yii/jui/README.md
  21. 2
      extensions/yii/mongodb/README.md
  22. 2
      extensions/yii/redis/README.md
  23. 2
      extensions/yii/smarty/README.md
  24. 2
      extensions/yii/sphinx/README.md
  25. 2
      extensions/yii/swiftmailer/README.md
  26. 2
      extensions/yii/twig/README.md
  27. 2
      framework/README.md

2
apps/advanced/README.md

@ -70,7 +70,7 @@ at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).
You can then install the application using the following command: You can then install the application using the following command:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-advanced advanced php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-advanced advanced
~~~ ~~~

2
apps/basic/README.md

@ -52,7 +52,7 @@ at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).
You can then install this application template using the following command: You can then install this application template using the following command:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-basic basic php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic basic
~~~ ~~~
Now you should be able to access the application through the following URL, assuming `basic` is the directory Now you should be able to access the application through the following URL, assuming `basic` is the directory

2
apps/benchmark/README.md

@ -43,7 +43,7 @@ curl -s http://getcomposer.org/installer | php
You can then install the Bootstrap Application using the following command: You can then install the Bootstrap Application using the following command:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-benchmark yii-benchmark php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-benchmark yii-benchmark
~~~ ~~~
Now you should be able to access the benchmark page using the URL Now you should be able to access the benchmark page using the URL

4
docs/guide/apps-advanced.md

@ -20,7 +20,7 @@ curl -s http://getcomposer.org/installer | php
You can then install the application using the following command: You can then install the application using the following command:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-advanced /path/to/yii-application php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-advanced /path/to/yii-application
~~~ ~~~
Getting started Getting started
@ -171,5 +171,5 @@ your project.
Now the interesting part. You can add more packages your application needs to `require` section. Now the interesting part. You can add more packages your application needs to `require` section.
All these packages are coming from [packagist.org](https://packagist.org/) so feel free to browse the website for useful code. All these packages are coming from [packagist.org](https://packagist.org/) so feel free to browse the website for useful code.
After your `composer.json` is changed you can run `php composer.phar update`, wait till packages are downloaded and After your `composer.json` is changed you can run `php composer.phar update --prefer-dist`, wait till packages are downloaded and
installed and then just use them. Autoloading of classes will be handled automatically. installed and then just use them. Autoloading of classes will be handled automatically.

4
docs/guide/apps-basic.md

@ -20,7 +20,7 @@ curl -s http://getcomposer.org/installer | php
You can then install the Bootstrap Application using the following command: You can then install the Bootstrap Application using the following command:
~~~ ~~~
php composer.phar create-project --stability=dev yiisoft/yii2-app-basic /path/to/yii-application php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic /path/to/yii-application
~~~ ~~~
Now set document root directory of your Web server to /path/to/yii-application/web and you should be able to access the application using the URL `http://localhost/`. Now set document root directory of your Web server to /path/to/yii-application/web and you should be able to access the application using the URL `http://localhost/`.
@ -159,5 +159,5 @@ your project.
Now the interesting part. You can add more packages your application needs to `require` section. Now the interesting part. You can add more packages your application needs to `require` section.
All these packages are coming from [packagist.org](https://packagist.org/) so feel free to browse the website for useful code. All these packages are coming from [packagist.org](https://packagist.org/) so feel free to browse the website for useful code.
After your `composer.json` is changed you can run `php composer.phar update`, wait till packages are downloaded and After your `composer.json` is changed you can run `php composer.phar update --prefer-dist`, wait till packages are downloaded and
installed and then just use them. Autoloading of classes will be handled automatically. installed and then just use them. Autoloading of classes will be handled automatically.

4
docs/guide/composer.md

@ -44,7 +44,7 @@ Once you have edited the `composer.json`, you can invoke Composer to install the
For the first installation of the dependencies, use this command: For the first installation of the dependencies, use this command:
``` ```
php composer.phar install php composer.phar install --prefer-dist
``` ```
This must be executed within your Yii project's directory, where the `composer.json` file can be found. This must be executed within your Yii project's directory, where the `composer.json` file can be found.
@ -54,7 +54,7 @@ to the `composer.phar` script.
For an existing installation, you can have Composer update the dependencies using: For an existing installation, you can have Composer update the dependencies using:
``` ```
php composer.phar update php composer.phar update --prefer-dist
``` ```
Again, you may need to provide specific path references. Again, you may need to provide specific path references.

2
docs/guide/gii.md

@ -14,7 +14,7 @@ Gii comes as an offical extension and the preferred way to install this extensio
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-gii "*" php composer.phar require --prefer-dist yiisoft/yii2-gii "*"
``` ```
or add or add

2
docs/guide/template.md

@ -38,7 +38,7 @@ your `composer.json` to include
"yiisoft/yii2-twig": "*", "yiisoft/yii2-twig": "*",
``` ```
in `require` section and then run `composer update`. in `require` section and then run `composer update --preder-dist`.
Twig Twig
---- ----

2
docs/guide/view.md

@ -93,7 +93,7 @@ adding the following to `require`:
"ezyang/htmlpurifier": "v4.6.0" "ezyang/htmlpurifier": "v4.6.0"
``` ```
After it's done run `php composer.phar install` and wait till package is downloaded. Now everything is prepared to use After it's done run `php composer.phar install --prefer-dist` and wait till package is downloaded. Now everything is prepared to use
Yii's HtmlPurifier helper: Yii's HtmlPurifier helper:
```php ```php

3
docs/internals/getting-started.md

@ -7,7 +7,8 @@ Composer package. Here's how to do it:
1. `git clone git@github.com:yiisoft/yii2-app-basic.git`. 1. `git clone git@github.com:yiisoft/yii2-app-basic.git`.
2. Remove `.git` directory from cloned directory. 2. Remove `.git` directory from cloned directory.
3. Change `composer.json`. Instead of all stable requirements add just one `"yiisoft/yii2-dev": "*"`. 3. Change `composer.json`. Instead of all stable requirements add just one `"yiisoft/yii2-dev": "*"`.
4. Execute `composer create-project`. 4. Execute `composer create-project`. Do not add `--prefer-dist` to the command since it will not download git repository
then.
5. Now you have working playground that uses latest code. 5. Now you have working playground that uses latest code.
Note that requirements of extensions that come with `yii2-dev` are not loaded automatically. Note that requirements of extensions that come with `yii2-dev` are not loaded automatically.

2
extensions/yii/apidoc/README.md

@ -11,7 +11,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-apidoc "*" php composer.phar require --prefer-dist yiisoft/yii2-apidoc "*"
``` ```
or add or add

2
extensions/yii/authclient/README.md

@ -12,7 +12,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-authclient "*" php composer.phar require --prefer-dist yiisoft/yii2-authclient "*"
``` ```
or add or add

2
extensions/yii/bootstrap/README.md

@ -19,7 +19,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-bootstrap "*" php composer.phar require --prefer-dist yiisoft/yii2-bootstrap "*"
``` ```
or add or add

2
extensions/yii/codeception/README.md

@ -17,7 +17,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-codeception "*" php composer.phar require --prefer-dist yiisoft/yii2-codeception "*"
``` ```
or add or add

2
extensions/yii/debug/README.md

@ -14,7 +14,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-debug "*" php composer.phar require --prefer-dist yiisoft/yii2-debug "*"
``` ```
or add or add

2
extensions/yii/elasticsearch/README.md

@ -31,7 +31,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-elasticsearch "*" php composer.phar require --prefer-dist yiisoft/yii2-elasticsearch "*"
``` ```
or add or add

2
extensions/yii/faker/README.md

@ -12,7 +12,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-faker "*" php composer.phar require --prefer-dist yiisoft/yii2-faker "*"
``` ```
or add or add

2
extensions/yii/gii/README.md

@ -13,7 +13,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-gii "*" php composer.phar require --prefer-dist yiisoft/yii2-gii "*"
``` ```
or add or add

2
extensions/yii/imagine/README.md

@ -12,7 +12,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-imagine "*" php composer.phar require --prefer-dist yiisoft/yii2-imagine "*"
``` ```
or add or add

2
extensions/yii/jui/README.md

@ -28,7 +28,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-jui "*" php composer.phar require --prefer-dist yiisoft/yii2-jui "*"
``` ```
or add or add

2
extensions/yii/mongodb/README.md

@ -14,7 +14,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-mongodb "*" php composer.phar require --prefer-dist yiisoft/yii2-mongodb "*"
``` ```
or add or add

2
extensions/yii/redis/README.md

@ -29,7 +29,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-redis "*" php composer.phar require --prefer-dist yiisoft/yii2-redis "*"
``` ```
or add or add

2
extensions/yii/smarty/README.md

@ -29,7 +29,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-smarty "*" php composer.phar require --prefer-dist yiisoft/yii2-smarty "*"
``` ```
or add or add

2
extensions/yii/sphinx/README.md

@ -12,7 +12,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-sphinx "*" php composer.phar require --prefer-dist yiisoft/yii2-sphinx "*"
``` ```
or add or add

2
extensions/yii/swiftmailer/README.md

@ -37,7 +37,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-swiftmailer "*" php composer.phar require --prefer-dist yiisoft/yii2-swiftmailer "*"
``` ```
or add or add

2
extensions/yii/twig/README.md

@ -32,7 +32,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-twig "*" php composer.phar require --prefer-dist yiisoft/yii2-twig "*"
``` ```
or add or add

2
framework/README.md

@ -12,7 +12,7 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require "yiisoft/yii2 *" php composer.phar require --prefer-dist "yiisoft/yii2 *"
``` ```
or add or add

Loading…
Cancel
Save