Skip to content

Commit e5c6b8c

Browse files
authored
Merge pull request #6 from codeigniter4/folders
2 parents 3f910a6 + 73eca6c commit e5c6b8c

16 files changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ locally they will need to be installed. All of them (except Rector) are availabl
4141
* [PHP CS Fixer](https://cs.symfony.com/)
4242
* [Rector](https://github.com/rectorphp/rector/)
4343

44-
## Source Files
44+
## Template Files
4545

46-
The provided source files should be considered guidelines or templates for your own use, as
47-
they may need changing to fit your environment. These are based on the following assumptions:
46+
The provided source files (in **Template/**) should be considered guidelines for your own use,
47+
as they may need changing to fit your environment. These are based on the following assumptions:
4848

4949
1. Your default repository branch is set to `develop`
5050
2. You use Composer to manage all necessary dependencies
@@ -56,7 +56,7 @@ they may need changing to fit your environment. These are based on the following
5656

5757
This kit includes a number of workflow templates for integrating [GitHub Actions](https://docs.github.com/en/actions)
5858
into your library or project development process. To add these to your repo simply copy the
59-
workflows into a **.github/workflows/** directory.
59+
workflows into a **Template/.github/workflows/** directory.
6060

6161
> Hint: the [source files](src/.github) also include a configuration for Dependabot which will help keep your dependencies and workflows updated.
6262
@@ -136,10 +136,16 @@ so be sure to read the documentation and figure out the best fit for you. This w
136136
a "dry run" to check for any changes that Rector would have made and fail if there are matches.
137137

138138
> Note: Rector updates rules all the time so you may want to lock your repo to the latest known working version of Rector to prevent unexpected failures
139-
> E.g. in **.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4`
139+
> E.g. in **Template/.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4`
140140
141141
#### Unused
142142

143143
Composer Unused does one thing: checks that your code actually uses the dependencies you
144144
have included via Composer. It can be easy to forget to update your **composer.json** when
145145
your code drops a dependency, so this workflow will help track those down.
146+
147+
## Example Files
148+
149+
Besides the template files, this repo includes some examples for integrating CodeIgniter
150+
with other third-party resources. These files (in **Examples/**) may change over time and
151+
should not be relied on for anything more than a reference for your own code.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)