Defat of format description

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..6c19184
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,96 @@
+Format of the files with metadata
+=================================
+
+
+General formatting rules
+------------------------
+
+- Each file consists of one or more sections
+- Each section separated by one or more empty lines
+- Each line in section starts with capital letter (key),colon and space(s)
+- Lines without key element are ignored
+
+
+Git tree project object
+-----------------------
+
+Filename: "git-trees"
+    T: [mandatory] tree path
+    D: [mandatory] Domain
+    O: [optional] Description
+    P: [optional] Profile (Mobile,IVI,...)
+    S: [optional] Status (Maintained, Obsoleted, ...)
+    M: [optional] Maintainer(s)
+    I: [optional] Integrator(s)
+    R: [optional] Reviewers(s)
+    B: [optional] Branch(es)
+    L: [optional] License(s)
+    H: [optional] Web site or web page related to project
+    U: [optional] Upstream URL
+    V: [optional] Upstream version control system URL
+    C: [optional] Comments
+
+
+Domain object
+-------------
+
+Filename: "domains"
+    D: [mandatory] Domain
+    A: [mandatory] Architect(s)
+    P: [optional] Profile (Mobile,IVI,...)
+    O: [optional] Description
+    S: [optional] Status (Maintained, Obsoleted, ...)
+    M: [optional] Maintainer(s)
+    I: [optional] Integrator(s)
+    R: [optional] Reviewers(s)
+    H: [optional] Web site or web page related to project
+    N: [optional] reserved for parent domain (in case of declaring sub-domains)
+    C: [optional] Comments
+
+
+Branche object
+--------------
+
+Filename: "branches"
+    B: [mandatory] Branch
+    O: [optional] Description
+    P: [optional] Profile (Mobile,IVI,...)
+    S: [optional] Status (?)
+    Z: [optional] OBS project mapping (?)
+    C: [optional] Comments
+
+
+Reference
+---------
+
+Field keys:
+    A - Architect. Format: FullName <address@domain>
+    B - Branch. Format: [a-z0-9\._]+
+    C - Comments.
+    D - Domain.
+    E - ?
+    F - ?
+    G - ?
+    H - Homepage URL
+    I - Integrator. Format: FullName <address@domain>
+    J - ?
+    K - ? 
+    L - Licenses
+    M - Maintainer. Format: FullName <address@domain>
+    N - PareNt. References another domain object.
+    O - DescriptiOn.
+    P - Profile.
+    Q - ?
+    R - Reviewers.
+    S - Status.
+    T - Tree path.
+    U - Upstream.
+    V - Upstream VCS.
+    W - ?
+    X - ?
+    Y - ?
+    Z - OBS mapping?
+
+
+
+