More readme files.

tsetliff · tsetliff · commit da8393bf1b3b · 2016-02-28T14:26:26.000-05:00
diff --git a/template/app/src/YourName/YourProject/Config/README b/template/app/src/YourName/YourProject/Config/README
@@ -0,0 +1,6 @@
+The configuration class is chosen by the environment variable in config.php in the app directory.  Throughout
+your project however you just call Config::instance()->parameterName.  This allows for auto complete in the IDE.
+Every parameter should be defined in Config and other environment dependent changes should be made in ConfigDev,
+ConfigProd etc.
+
+Generally works like the Di.
diff --git a/template/app/src/YourName/YourProject/Controller/README b/template/app/src/YourName/YourProject/Controller/README
@@ -0,0 +1,2 @@
+Here is where the routes called in the URL go. Your controllers should extend base controller.  This is also
+where you should use the dependency injector to get instances of business logic objects.
diff --git a/template/app/src/YourName/YourProject/Di/README b/template/app/src/YourName/YourProject/Di/README
@@ -0,0 +1,7 @@
+The class here is chosen by the environment variable set in config.php in the root app directory.  It will also
+assign that to be the class that is returned when you call Di::instance() within your controller classes.
+
+Every method should be defined on the Di class and then over ridden in an environment specific class.
+
+This allows you to return different objects based on if it is production or development for example if you use a
+different logger like MonoLog in production.
diff --git a/template/public_html/css/.gitignore b/template/public_html/css/.gitignore
diff --git a/template/public_html/css/README b/template/public_html/css/README
@@ -0,0 +1 @@
+Location for your CSS files.
diff --git a/template/public_html/img/.gitignore b/template/public_html/img/.gitignore
diff --git a/template/public_html/img/README b/template/public_html/img/README
@@ -0,0 +1 @@
+Location for your images
diff --git a/template/public_html/js/.gitignore b/template/public_html/js/.gitignore
diff --git a/template/public_html/js/README b/template/public_html/js/README
@@ -0,0 +1 @@
+Location for your javascript files.  I'm guessing you knew that but this way git doesn't delete this directory ;-)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Here is where the routes called in the URL go. Your controllers should extend base controller. This is also`
	`2`	`+where you should use the dependency injector to get instances of business logic objects.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Location for your javascript files. I'm guessing you knew that but this way git doesn't delete this directory ;-)`