Skip to content

Commit 8401b5f

Browse files
committed
Add some doc notes
1 parent 459004e commit 8401b5f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ command makes the following assumptions (and will fail if they are not met):
2323
* You project is in an existing Git repository
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)
26-
* Your project files are in their standard locations (**app/**, **public/**, **writable/**, etc)
26+
* Your project files are in their standard locations (**app/**, **public/**, **env**, **spark**)
27+
* You have no ignored files in **app/** or **public/** that the patch process would disrupt
2728

2829
## Installation
2930

@@ -190,6 +191,12 @@ you run the test cases first. Clone or download the repo and launch the tests wi
190191

191192
./tests/run
192193

194+
### Clean Up
195+
196+
* It is **always** safe to delete `tatter/scratch` - this branch has nothing relevant to your project.
197+
* It is **always** safe to delete `tatter/patches`, but if you have not committed and merged the changes then you will need to start the patch process over.
198+
* Should you decide not to use **Patches** anymore just remove the Composer package or delete the script - that's all!
199+
193200
### Recovery
194201

195202
**Patches** is very conservative and takes many precautions not to touch any of your project files.

0 commit comments

Comments
 (0)