Add README files in packages

[tools/sat.git] / src / internal_config / README_SAT.template

diff --git a/src/internal_config/README_SAT.template b/src/internal_config/README_SAT.template
new file mode 100644 (file)
index 0000000..133807c
--- /dev/null
+++ b/src/internal_config/README_SAT.template
@@ -0,0 +1,14 @@
+# This package was generated with sat ¤{version}
+# Date: ¤{date}
+# User: ¤{user}
+
+In the following, $ROOT represents the directory where this file is located.
+
+This package includes salomeTools.
+
+You can add a project to salomeTools by editing the file $ROOT/data/site.pyconf
+and add a project file in the section PROJECTS:
+PROJECTS :
+{
+    project_file_paths : ["HERE"]
+}