summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
Diffstat (limited to 'core')
-rw-r--r--core/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/core/README.md b/core/README.md
index 8dee940..2fdd951 100644
--- a/core/README.md
+++ b/core/README.md
@@ -19,8 +19,25 @@ Main advantages of the framework:
* Some webserver (Apache/Nginx)
* Some SQL server (MySQL/MariaDB/Postgress)
* Basic knowledge of php and SQL
+* Baasic knowlege of OOP
+### Code standards
+
+Amon uses the PSR-1 code standard with a few enchansements:
+
+Controllers are named like
+
+ class SomeController
+ // or...
+ class SomeController_something
+
+where ```something``` indicates some special operational role of the contoller
+ex. ```_user```, ```_service```, ```manager``` etc
+
+As a result all model classes are suffixed with ```_model```:
+
+ class SomeModelName_model;
### What is included