Skip to content

Commit

Permalink
make documentation consistent with the default composer.json file
Browse files Browse the repository at this point in the history
  • Loading branch information
mollux committed May 4, 2022
1 parent 8087474 commit 89ce75e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ all files not excluded by the .gitignore file.

When installing the given `composer.json` some tasks are taken care of:

* Mautic will be installed in the `public`-directory.
* Mautic will be installed in the `docroot`-directory.
* Autoloader is implemented to use the generated composer autoloader in `vendor/autoload.php`,
instead of the one provided by Mautic (`public/vendor/autoload.php`).
* Plugins (packages of type `mautic-plugin`) will be placed in `public/plugins/`
* Themes (packages of type `mautic-theme`) will be placed in `public/themes/`
* Creates `public/media`-directory.
instead of the one provided by Mautic (`docroot/vendor/autoload.php`).
* Plugins (packages of type `mautic-plugin`) will be placed in `docroot/plugins/`
* Themes (packages of type `mautic-theme`) will be placed in `docroot/themes/`
* Creates `docroot/media`-directory.
* Creates environment variables based on your .env file. See [.env.example](.env.example).

## Updating Mautic Core
Expand All @@ -56,7 +56,7 @@ Follow the steps below to update your core files.
2. Run `git diff` to determine if any of the scaffolding files have changed.
Review the files for any changes and restore any customizations to
`.htaccess` or others.
1. Commit everything all together in a single commit, so `public` will remain in
1. Commit everything all together in a single commit, so `docroot` will remain in
sync with the `core` when checking out branches or running `git bisect`.
1. In the event that there are non-trivial conflicts in step 2, you may wish
to perform these steps on a branch, and use `git merge` to combine the
Expand All @@ -75,7 +75,7 @@ workrounds if a project decides to do it anyway](https://getcomposer.org/doc/faq
### Should I commit the scaffolding files?

The [Mautic Composer Scaffold](https://github.com/mautic/core-composer-scaffold) plugin can download the scaffold files (like
index.php, .htaccess, …) to the public/ directory of your project. If you have not customized those files you could choose
index.php, .htaccess, …) to the docroot/ directory of your project. If you have not customized those files you could choose
to not check them into your version control system (e.g. git). If that is the case for your project it might be
convenient to automatically run the mautic-scaffold plugin after every install or update of your project. You can
achieve that by registering `@composer mautic:scaffold` as post-install and post-update command in your composer.json:
Expand Down

0 comments on commit 89ce75e

Please sign in to comment.