Skip to content

Commit 2da8ef8

Browse files
authored
Merge pull request #6357 from kenjis/fix-docs-installing_composer.rst
docs: fix installing
2 parents 23a18eb + d0f0881 commit 2da8ef8

File tree

2 files changed

+12
-28
lines changed

2 files changed

+12
-28
lines changed

user_guide_src/source/installation/installing_composer.rst

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Initial Configuration
5656
---------------------
5757

5858
After installation, a few initial configurations are required.
59-
See :ref:`initial-configuration` for the details.
59+
See :ref:`initial-configuration` for the details.
6060

6161
.. _app-starter-upgrading:
6262

@@ -67,17 +67,6 @@ Whenever there is a new release, then from the command line in your project root
6767

6868
> composer update
6969

70-
If you want to compare the latest framework source structure for non-system directory (app, public, etc), you can update with ``--prefer-source``::
71-
72-
> composer update codeigniter4/framework --prefer-source
73-
74-
If ``--prefer-source`` doesn't automatically update to pull latest framework source structure, you can remove first::
75-
76-
rm -rf vendor/codeigniter4/framework && composer update codeigniter4/framework --prefer-source
77-
78-
If you used the ``--no-dev`` option when you created the project, it
79-
would be appropriate to do so here too, i.e., ``composer update --no-dev``.
80-
8170
Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
8271

8372
Pros
@@ -97,7 +86,6 @@ Folders in your project after set up:
9786

9887
- app, public, tests, writable
9988
- vendor/codeigniter4/framework/system
100-
- vendor/codeigniter4/framework/app & public (compare with yours after updating when using ``--prefer-source``)
10189

10290
Latest Dev
10391
----------
@@ -112,13 +100,13 @@ develop branch explicitly.
112100

113101
In your project root::
114102

115-
php builds development
103+
> php builds development
116104

117105
The command above will update **composer.json** to point to the ``develop`` branch of the
118106
working repository, and update the corresponding paths in config and XML files. To revert
119107
these changes run::
120108

121-
php builds release
109+
> php builds release
122110

123111
After using the ``builds`` command be sure to run ``composer update`` to sync your vendor
124112
folder with the latest target build.
@@ -138,22 +126,17 @@ will be your document root.
138126

139127
In your project root::
140128

141-
> composer require codeigniter4/framework --prefer-source
129+
> composer require codeigniter4/framework
142130

143-
As with the earlier two composer install methods, you can omit installing
131+
As with the earlier composer install method, you can omit installing
144132
phpunit and its dependencies by adding the ``--no-dev`` argument to the ``composer require`` command.
145133

146134
Setting Up
147135
----------
148136

149-
Copy the ``app``, ``public``, and ``writable`` folders from ``vendor/codeigniter4/framework``
150-
to your project root
151-
152-
Copy the ``env``, ``phpunit.xml.dist`` and ``spark`` files, from
153-
``vendor/codeigniter4/framework`` to your project root
154-
155-
You will have to adjust the system path to refer to the vendor one, e.g., ``ROOTPATH . '/vendor/codeigniter4/framework/system'``,
156-
- the ``$systemDirectory`` variable in **app/Config/Paths.php**
137+
1. Copy the ``app``, ``public``, ``tests`` and ``writable`` folders from ``vendor/codeigniter4/framework`` to your project root
138+
2. Copy the ``env``, ``phpunit.xml.dist`` and ``spark`` files, from ``vendor/codeigniter4/framework`` to your project root
139+
3. You will have to adjust the ``$systemDirectory`` property in **app/Config/Paths.php** to refer to the vendor one, e.g., ``ROOTPATH . '/vendor/codeigniter4/framework/system'``.
157140

158141
Initial Configuration
159142
---------------------
@@ -168,7 +151,7 @@ Upgrading
168151

169152
Whenever there is a new release, then from the command line in your project root::
170153

171-
> composer update --prefer-source
154+
> composer update
172155

173156
Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
174157

@@ -187,7 +170,7 @@ Structure
187170

188171
Folders in your project after set up:
189172

190-
- app, public, writable (when using ``--prefer-source``)
173+
- app, public, tests, writable
191174
- vendor/codeigniter4/framework/system
192175

193176
Translations Installation

user_guide_src/source/installation/installing_manual.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ Structure
5555
=========
5656

5757
Folders in your project after set up:
58-
app, public, system, writable
58+
59+
- app, public, tests, writable, system
5960

6061
Translations Installation
6162
=========================

0 commit comments

Comments
 (0)