From b52e052bd3741c1ddf1bdaa43079ba5a9eafc8bd Mon Sep 17 00:00:00 2001
From: Geo Halkiadakis <gchalkiadakis@sklavenitis.co.gr>
Date: Thu, 27 Apr 2023 18:16:44 +0300
Subject: setting blueprint in action

---
 core/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'core')

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
-- 
cgit v1.2.3