From 2bb4dedd19ede2fb52e61b790cb8ec87445bed95 Mon Sep 17 00:00:00 2001 From: Daniel Klein Date: Sun, 2 Jan 2022 11:09:36 +1100 Subject: [PATCH] Clarify instructions by changing project name to project directory --- best_practices.rst | 2 +- setup.rst | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/best_practices.rst b/best_practices.rst index 3ddb7aa67ac..dcc0d9eb3f2 100644 --- a/best_practices.rst +++ b/best_practices.rst @@ -30,7 +30,7 @@ to create new Symfony applications: .. code-block:: terminal - $ symfony new my_project_name + $ symfony new my_project_directory Under the hood, this Symfony binary command executes the needed `Composer`_ command to :ref:`create a new Symfony application ` diff --git a/setup.rst b/setup.rst index 795c9349437..ad7d3de15b2 100644 --- a/setup.rst +++ b/setup.rst @@ -54,10 +54,10 @@ application: .. code-block:: terminal # run this if you are building a traditional web application - $ symfony new my_project_name --version=4.4 --full + $ symfony new my_project_directory --version=4.4 --full # run this if you are building a microservice, console application or API - $ symfony new my_project_name --version=4.4 + $ symfony new my_project_directory --version=4.4 The only difference between these two commands is the number of packages installed by default. The ``--full`` option installs all the packages that you @@ -69,13 +69,13 @@ Symfony application using Composer: .. code-block:: terminal # run this if you are building a traditional web application - $ composer create-project symfony/website-skeleton:"^4.4" my_project_name + $ composer create-project symfony/website-skeleton:"^4.4" my_project_directory # run this if you are building a microservice, console application or API - $ composer create-project symfony/skeleton:"^4.4" my_project_name + $ composer create-project symfony/skeleton:"^4.4" my_project_directory No matter which command you run to create the Symfony application. All of them -will create a new ``my_project_name/`` directory, download some dependencies +will create a new ``my_project_directory/`` directory, download some dependencies into it and even generate the basic directories and files you'll need to get started. In other words, your new application is ready! @@ -258,20 +258,20 @@ stable version. If you want to use an LTS version, add the ``--version`` option: .. code-block:: terminal # use the most recent LTS version - $ symfony new my_project_name --version=lts + $ symfony new my_project_directory --version=lts # use the 'next' Symfony version to be released (still in development) - $ symfony new my_project_name --version=next + $ symfony new my_project_directory --version=next # you can also select an exact specific Symfony version - $ symfony new my_project_name --version=4.4 + $ symfony new my_project_directory --version=4.4 The ``lts`` and ``next`` shortcuts are only available when using Symfony to create new projects. If you use Composer, you need to tell the exact version: .. code-block:: terminal - $ composer create-project symfony/skeleton:"^4.4" my_project_name + $ composer create-project symfony/skeleton:"^4.4" my_project_directory The Symfony Demo application ---------------------------- @@ -284,7 +284,7 @@ Run this command to create a new project based on the Symfony Demo application: .. code-block:: terminal - $ symfony new my_project_name --demo + $ symfony new my_project_directory --demo Start Coding! -------------