Salome HOME
initial commit
authorvsr <vsr@opencascade.com>
Mon, 7 Apr 2014 11:02:01 +0000 (15:02 +0400)
committervsr <vsr@opencascade.com>
Mon, 7 Apr 2014 11:02:01 +0000 (15:02 +0400)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f0b5fc3
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+This is service repository that contains different maintenance utilities for
+SALOME project.
+
+1) Versioning SALOME stable builds.
+
+Each SALOME development build queue is serialized by dumping versioning
+information into dedicated files. Each such file has the following structure:
+
+-----> start of the file
+# Comment lines start with '#' symbol.
+[SALOME]
+<module> = <git commit id>
+...
+
+[PRODUCTS]
+<product> = <version info>
+...
+-----> end of the file
+
+Here,
+- <module> is a name of SALOME module (plugin, tool);
+- <git commit id> is a corresponding git repository commit hash;
+- <product> is a (symbolic) name of the pre-requisite (e.g. "qt", "python");
+- <version info> is a version information for the product.
+
+Each development build queue is dumped into a separate file; name of the file
+contains the information about the build queue. For example:
+- series7x_occt_stable : build SALOME series 7x (from master branch) 
+  with stable version of OCCT;
+- series7x_occt_dev : build SALOME series 7x (from master branch)
+  with dev version of OCCT.
+
+Notes:
+- The script that creates versioning file obtains an information about the
+  pre-requisite products from the environment variables. Since there are no
+  dedicated environment variables for some secondary products (like jinja2,
+  pygments, docutils, etc), not all products info is available in the file.
+- For OCCT development version, the OCCT Git tag is used as version information.