Skip to content

Commit 2fd3199

Browse files
justinbeatyfballiano
authored andcommitted
Update install instructions in README (#2981)
1 parent ae95378 commit 2fd3199

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ level of backwards compatibility to the official releases.
2323
- [Requirements](#requirements)
2424
- [Optional](#optional)
2525
- [Installation](#installation)
26+
- [Manual Install](#manual-install)
2627
- [Composer](#composer)
2728
- [Git](#git)
2829
- [Secure your installation](#secure-your-installation)
@@ -61,21 +62,64 @@ __Please be aware that although OpenMage is compatible that one or more extensio
6162

6263
## Installation
6364

65+
### Manual Install
66+
67+
Download the latest [release archive](https://github.com/OpenMage/magento-lts/releases) and extract it over your existing install. **Important:** you must download the ZIP file from a tagged version on the releases page, otherwise there will be missing dependencies.
68+
6469
### Composer
6570

66-
Download the latest archive and extract it, clone the repo, or add a composer dependency to your existing project like so:
71+
Step 1: Create a new composer project:
6772

6873
```bash
69-
composer require "openmage/magento-lts":"^19.5.0"
74+
composer init
7075
```
7176

72-
To get the latest changes use:
77+
Step 2: Configure composer. **The below options are required.** You can see all options [here](https://github.com/AydinHassan/magento-core-composer-installer#configuration).
7378

7479
```bash
75-
composer require "openmage/magento-lts":"dev-main"
80+
# Allow composer to apply patches to dependencies of magento-lts
81+
composer config --json extra.enable-patching true
82+
83+
# Configure Magento core composer installer to use magento-lts as the Magento source package
84+
composer config extra.magento-core-package-type magento-source
85+
86+
# Configure the root directory that magento-lts will be installed to, such as "pub", "htdocs", or "www"
87+
composer config extra.magento-root-dir pub
88+
```
89+
90+
Step 3: Require `magento-core-composer-installer`:
91+
92+
``` bash
93+
# PHP 7
94+
composer require "aydin-hassan/magento-core-composer-installer":"~2.0.0"
95+
96+
# PHP 8
97+
composer require "aydin-hassan/magento-core-composer-installer":"^2.1.0"
7698
```
7799

78-
<small>Note: `dev-main` is just an alias for current `1.9.4.x` branch and may change</small>
100+
<small>Note: be sure to select `y` if composer asks you to trust `aydin-hassan/magento-core-composer-installer`.</small>
101+
102+
Step 4: Require `magento-lts`:
103+
104+
```bash
105+
# OpenMage v19
106+
composer require "openmage/magento-lts":"^19.4.0"
107+
108+
# OpenMage v20
109+
composer require "openmage/magento-lts":"^20.0.0"
110+
```
111+
112+
<small>Note: be sure to select `y` if composer asks you to trust `magento-hackathon/magento-composer-installer` or `cweagans/composer-patches`.</small>
113+
114+
To install the latest development version (may be unstable):
115+
116+
```bash
117+
# OpenMage v19
118+
composer require "openmage/magento-lts":"1.9.4.x-dev"
119+
120+
# OpenMage v20
121+
composer require "openmage/magento-lts":"20.0.x-dev"
122+
```
79123

80124
### Git
81125

0 commit comments

Comments
 (0)