tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

DOCS Update notes on —prefer-source/dist

Browse Source 
Fixes https://github.com/silverstripe/silverstripe-installer/issues/186
This commit is contained in:
Damian Mooyman 2017-06-30 13:19:18 +12:00
parent ee05c586b6
commit 60303571e4
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/en/00_Getting_Started/02_Composer.md
View File

@ -44,6 +44,13 @@ Composer can create a new site for you, using the installer as a template (by de
composer create-project silverstripe/installer ./my/website/folder composer create-project silverstripe/installer ./my/website/folder
``` ```
If you want to get all additional fixtures for testing, such as behat and phpunit configuration,
an example `.env.example` file, and all documentation, then it's recommended to use `--prefer-source`
to include these files.
If you want a minimal installation with the bare essentials to get working without any additional overhead,
and don't plan on contributing back changes to framework, use `--prefer-dist` (default) for a more lightweight install.
`./my/website/folder` should be the root directory where your site will live. `./my/website/folder` should be the root directory where your site will live.
For example, on OS X, you might use a subdirectory of `~/Sites`. For example, on OS X, you might use a subdirectory of `~/Sites`.
As long as your web server is up and running, this will get all the code that you need. As long as your web server is up and running, this will get all the code that you need.
@ -205,7 +212,7 @@ You have to tell composer three things in order to be able to do this:
The first two steps are done as part of the initial create project using additional arguments. The first two steps are done as part of the initial create project using additional arguments.
``` ```
composer create-project --keep-vcs --dev silverstripe/installer ./my/website/folder 4.0.x-dev composer create-project --keep-vcs --dev silverstripe/installer ./my/website/folder 4.0.x-dev --prefer-source
``` ```
The process will take a bit longer, since all modules are checked out as full git repositories which you can work on. The command checks out from the 4.0 release line. To check out from master instead, The process will take a bit longer, since all modules are checked out as full git repositories which you can work on. The command checks out from the 4.0 release line. To check out from master instead,