Skip to content

docs: add command prompt > before composer #5433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2021
Merged

docs: add command prompt > before composer #5433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions user_guide_src/source/installation/installing_composer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Installation & Set Up

In the folder above your project root::

composer create-project codeigniter4/appstarter project-root
> composer create-project codeigniter4/appstarter project-root

The command above will create a "project-root" folder.

Expand All @@ -46,7 +46,7 @@ trusted dependencies that we bundle, being composer-installed.

A sample such installation command, using the default project-root "appstarter"::

composer create-project codeigniter4/appstarter --no-dev
> composer create-project codeigniter4/appstarter --no-dev

After installation you should follow the steps in the "Upgrading" section.

Expand All @@ -55,11 +55,11 @@ Upgrading

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

composer update
> composer update

If you want to compare the latest framework source structure for non-system directory (app, public, etc), you can update with ``--prefer-source``::

composer update codeigniter4/framework --prefer-source
> composer update codeigniter4/framework --prefer-source

If ``--prefer-source`` doesn't automatically update to pull latest framework source structure, you can remove first::

Expand Down Expand Up @@ -125,7 +125,7 @@ will be your document root.

In your project root::

composer require codeigniter4/framework --prefer-source
> composer require codeigniter4/framework --prefer-source

As with the earlier two composer install methods, you can omit installing
phpunit and its dependencies by adding the ``--no-dev`` argument to the ``composer require`` command.
Expand All @@ -147,7 +147,7 @@ Upgrading

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

composer update --prefer-source
> composer update --prefer-source

Read the upgrade instructions, and check designated
``app/Config`` folders for affected changes.
Expand Down Expand Up @@ -179,6 +179,6 @@ they can be added to your project in a similar fashion.

From the command line inside your project root::

composer require codeigniter4/translations
> composer require codeigniter4/translations

These will be updated along with the framework whenever you do a ``composer update``.
2 changes: 1 addition & 1 deletion user_guide_src/source/libraries/caching.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ Predis Caching
Predis is a flexible and feature-complete PHP client library for the Redis key-value store.
To use it, from the command line inside your project root::

composer require predis/predis
> composer require predis/predis

For more information on Redis, please see
`https://github.com/nrk/predis <https://github.com/nrk/predis>`_.
Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/tutorial/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ From your command line type the following:

::

composer create-project codeigniter4/appstarter ci-news
> composer create-project codeigniter4/appstarter ci-news

This creates a new folder, **ci-news**, which contains your application code, with
CodeIgniter installed in the vendor folder.
Expand Down