From 355826e568c7c5045763fbde7be242eac37768d7 Mon Sep 17 00:00:00 2001
From: Claudio Rosati <Claudio.Rosati@esss.se>
Date: Wed, 25 Jul 2018 07:34:08 +0200
Subject: [PATCH] README.md updated.

---
 README.md | 42 ++++++++++++++++++++++--------------------
 1 file changed, 22 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index d03a60eb..8addbbc0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # ESS CS-Studio OPIs
 
-This folder contains the validated and approved CS-Studio OPI files to be used 
+This folder contains the validated and approved CS-Studio OPI files to be used
 at ESS to control the facility.
 
 ## Structure
@@ -9,33 +9,33 @@ Here the structure of this folder:
 
 ```
 ess-opis/
-├── -common-
-│   ├── devices
-│   └── utilities
-├── control-room
-│   ├── -common-
+├── COMMON
+│   ├── DEVICES
+│   └── UTILITIES
+├── CONTROL-ROOM
 │   ├── accelerator
 │   ├── central-services
+│   ├── COMMON
 │   ├── machine-protection-system
 │   ├── neutron-instruments
 │   ├── personnel-safety-systems
 │   └── target-station
-└── engineering
-    ├── -common-
+└── ENGINEERING
     ├── accelerator
     ├── central-services
+    ├── COMMON
     ├── machine-protection-system
     ├── neutron-instruments
     ├── personnel-safety-systems
     └── target-station
 ```
 
-Each -common- folder should be used to contain OPIs common to that level. 
+Each COMMON folder should be used to contain OPIs common to that level.
 The folder has the following structure:
 
 ```
--common-/
-├── devices
+COMMON/
+├── DEVICES
 │   ├── beam-magnets-and-deflector
 │   ├── control-system
 │   ├── conventional-power
@@ -59,7 +59,7 @@ The folder has the following structure:
 │   ├── timing-system
 │   ├── vacuum
 │   └── water-cooling
-└── utilities
+└── UTILITIES
 ```
 
 Here the structure for the remaining folders in control-room and engineering:
@@ -151,25 +151,27 @@ target-station/
 
 - File and folder names should be in accordance with the naming conventions as
   much as possible.
-- Folder names must be all lowercase.
-- No white spaces are allowed in file/folder names: use '-' instead.
+- Folders named according to the naming conventions must have names in lowercase.
+- Folders used to structure the repository must have names in UPPERCASE.
+- No white spaces are allowed in file/folder names: use '-' instead or
+  CamelCase.
 
 ## Contributing the Repository
 
-The repository can be cloned by everyone interested in. Changes can be performed 
+The repository can be cloned by everyone interested in. Changes can be performed
 only through Pull Requests.
 
-Currently only Claudio Rosati (claudio.rosati@esss.se) and Bejamin Bertrand (for 
-safety, as Infrastructure Group member, benjamin.bertrand@esss.se) are allowed 
+Currently only Claudio Rosati (claudio.rosati@esss.se) and Bejamin Bertrand (for
+safety, as Infrastructure Group member, benjamin.bertrand@esss.se) are allowed
 to approve the pull requests, and merge them into the repository.
 
-As soon as someone else will be appointed to be in charge of this repository, 
+As soon as someone else will be appointed to be in charge of this repository,
 this readme file will be updated accordingly.
 
 ## Deployment
 
 The ess-opis repository is cloned and mounted in CS-Studio by the [Ansible role](https://gitlab.esss.lu.se/ics-ansible-galaxy/ics-ans-role-cs-studio)
 used to deploy CS-Studio.
-Every time a push is done on the master branch, it triggers an Ansible job via 
-AWX API to update the git repository on the LCR workstations. Refer to the 
+Every time a push is done on the master branch, it triggers an Ansible job via
+AWX API to update the git repository on the LCR workstations. Refer to the
 `.gitlab-ci.yml` file for the implementation.
-- 
GitLab