Skip to content

Commit bbed3f0

Browse files
committed
Updating README
1 parent e2cf3cf commit bbed3f0

File tree

1 file changed

+9
-36
lines changed

1 file changed

+9
-36
lines changed

README.md

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,36 @@
11
PHPChristmasMiracle
22
===================
33

4-
This application was created to accompany a presentation at
5-
[CodeWorks](http://codeworks.phparch.com/).
4+
This application was created to accompany a presentation called "The Great Framework Kumbaya"
65

76
The purpose is two-fold:
87

98
1. To highlight how similar frameworks are and how they can be used interchangeably
109

11-
2. To show how an app evolves from a flat PHP app into a reponsibly-organized
10+
2. To show how an app evolves from a flat PHP app into a responsibly-organized
1211
mini framework
1312

14-
Stages
15-
------
13+
Start and End Code
14+
------------------
1615

17-
This project is organized into six different stages, each representing one
18-
stage of the evolution of the app. You can checkout to different stages to
19-
see how things looked:
16+
The starting code is on the `master` branch. Hmm, simple enough.
2017

21-
* `start` - A flat, PHP4-style application
22-
23-
git checkout -b start origin/start
24-
25-
* `stage2` - Introduction of autoloader and Request and Response classes
26-
27-
git checkout -b stage2-http-foundation origin/stage2-http-foundation
28-
29-
* `stage3` - Introduction of a router
30-
31-
git checkout -b stage3-routing origin/stage3-routing
32-
33-
* `stage4` - Introduction of a dependency injection container
34-
35-
git checkout -b stage4-container origin/stage4-container
36-
37-
* `stage5` - Introduction of ZF2 logger
38-
39-
git checkout -b stage5-zf2-logger origin/stage5-zf2-logger
40-
41-
* `stage6` - Reorganization of the project's structure
42-
43-
git checkout -b stage6-dir-structure origin/stage6-dir-structure
18+
The finished code is on the `finished` branch. Again, that makes good sense :).
4419

4520
Usage
4621
-----
4722

4823
To use the app, clone it, check out to whichever branch you want, and do
4924
the following:
5025

51-
* Clone the repository
52-
53-
git clone git://github.com/weaverryan/PHPChristmasMiracle.git
54-
55-
* Initialize the database via `php data/setupDb.php`
26+
* Clone this repository
5627

5728
* Run Composer
5829

5930
composer install
6031

32+
* Initialize the database via `php data/setupDb.php`
33+
6134
If you have any permissions problems, run the following:
6235

6336
chmod 777 data/database.sqlite

0 commit comments

Comments
 (0)