@@ -17,10 +17,10 @@ stage any conflicts for easy resolution.
1717## Requirements
1818
1919** 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):
2222
23- * You project is in an existing Git repository
23+ * You project is in an existing Git repository (with configured Git user)
2424* The CodeIgniter 4 framework is installed via Composer in your ** vendor/** directory
2525* The current branch is "clean" (no uncommitted changes or unstaged files)
2626* 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):
3030
3131Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities
3232and always be up-to-date:
33- * ` > composer require --dev tatter/patches `
33+ ``` console
34+ > composer require --dev tatter/patches
35+ ```
3436
3537> Note: While ** Patches** can be run in a production environment it is strongly recommended
3638 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.
4244** Patches** comes with a single script, ` patch ` , which Composer will treat as a binary and
4345deploy to your ** vendor/bin/** folder. Simply run the command to kick off the patch process:
4446
45- ./vendor/bin/patch
47+ ./vendor/bin/patch
4648
4749### Arguments
4850
@@ -54,7 +56,7 @@ Git recognizes (branch, hash, tag, reference, revision, etc).
5456
5557Displays the latest command help:
5658
57- ``` shell
59+ ``` console
5860Usage: ./patch [-c <current version>] [-v <target version>]
5961
6062Patches an existing CodeIgniter 4 project repo to a different version of the framework.
@@ -75,7 +77,6 @@ commits. Examples:
7577 ./vendor/bin/patch -v 4.1.2
7678
7779* Patch up to a specific commit.
78-
7980 ./vendor/bin/patch -v dev-develop#0cff5488676f36f9e08874fdeea301222b6971a2
8081
8182#### Current (-c <commit-ish >)
@@ -103,7 +104,7 @@ for the configuration. Your project is running version `4.1.2` but wants to upda
103104use this new component. When ** Patches** simulates the update between these versions ` git ` will
104105notice the new file:
105106
106- ``` shell
107+ ``` console
107108A app/Config/Widget.php
108109```
109110
@@ -214,7 +215,7 @@ a `cherry-pick`. This is a technical Git process for isolating a single commit a
214215another branch. if you are mid-cherry-pick then ` git status ` should display the current state, as well
215216as any conflicting files and some hints for how to proceed:
216217
217- ``` shell
218+ ``` console
218219git status
219220On branch tatter/patches
220221You are currently cherry-picking commit a8b4361.
0 commit comments