@@ -17,10 +17,10 @@ stage any conflicts for easy resolution.
17
17
## Requirements
18
18
19
19
** Patches** is built on top of [ Git] ( https://git-scm.com ) and [ Composer] ( https://getcomposer.org ) ,
20
- so requires both of those be installed an accessible in your PATH. Additionally, the ` patch `
21
- command makes the following assumptions (and will fail if they are not met):
20
+ so requires both of those be installed and accessible in your ` $ PATH` . Additionally, the
21
+ ` patch ` command makes the following assumptions (and will fail if they are not met):
22
22
23
- * You project is in an existing Git repository
23
+ * You project is in an existing Git repository (with configured Git user)
24
24
* The CodeIgniter 4 framework is installed via Composer in your ** vendor/** directory
25
25
* The current branch is "clean" (no uncommitted changes or unstaged files)
26
26
* Your project files are in their standard locations (** app/** , ** public/** , ** env** , ** spark** )
@@ -30,7 +30,9 @@ command makes the following assumptions (and will fail if they are not met):
30
30
31
31
Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities
32
32
and always be up-to-date:
33
- * ` > composer require --dev tatter/patches `
33
+ ``` console
34
+ > composer require --dev tatter/patches
35
+ ```
34
36
35
37
> Note: While ** Patches** can be run in a production environment it is strongly recommended
36
38
that you install it in development (using ` --dev ` ) and then deploy the repo changes to production.
@@ -42,7 +44,7 @@ You may also download the script and add it to your favorite projects.
42
44
** Patches** comes with a single script, ` patch ` , which Composer will treat as a binary and
43
45
deploy to your ** vendor/bin/** folder. Simply run the command to kick off the patch process:
44
46
45
- ./vendor/bin/patch
47
+ ./vendor/bin/patch
46
48
47
49
### Arguments
48
50
@@ -54,7 +56,7 @@ Git recognizes (branch, hash, tag, reference, revision, etc).
54
56
55
57
Displays the latest command help:
56
58
57
- ``` shell
59
+ ``` console
58
60
Usage: ./patch [-c <current version>] [-v <target version>]
59
61
60
62
Patches an existing CodeIgniter 4 project repo to a different version of the framework.
@@ -75,7 +77,6 @@ commits. Examples:
75
77
./vendor/bin/patch -v 4.1.2
76
78
77
79
* Patch up to a specific commit.
78
-
79
80
./vendor/bin/patch -v dev-develop#0cff5488676f36f9e08874fdeea301222b6971a2
80
81
81
82
#### Current (-c <commit-ish >)
@@ -103,7 +104,7 @@ for the configuration. Your project is running version `4.1.2` but wants to upda
103
104
use this new component. When ** Patches** simulates the update between these versions ` git ` will
104
105
notice the new file:
105
106
106
- ``` shell
107
+ ``` console
107
108
A app/Config/Widget.php
108
109
```
109
110
@@ -214,7 +215,7 @@ a `cherry-pick`. This is a technical Git process for isolating a single commit a
214
215
another branch. if you are mid-cherry-pick then ` git status ` should display the current state, as well
215
216
as any conflicting files and some hints for how to proceed:
216
217
217
- ``` shell
218
+ ``` console
218
219
git status
219
220
On branch tatter/patches
220
221
You are currently cherry-picking commit a8b4361.
0 commit comments