Inital yang modules for O-RAN-SC

[scp/oam/modeling.git] / data-model / yang / working / o-ran-sc / template / README.md

diff --git a/data-model/yang/working/o-ran-sc/template/README.md b/data-model/yang/working/o-ran-sc/template/README.md
new file mode 100644 (file)
index 0000000..f61d925
--- /dev/null
+++ b/data-model/yang/working/o-ran-sc/template/README.md
@@ -0,0 +1,16 @@
+# Template
+
+This folder contains a template yang modules with dependencies to published
+YANG modules and O-RAN-SC common yang modules.
+
+Please rename "TEMPLATE" by your O-RAN component.
+
+Please use the option "-L, --dereference" of the bash "cp" command to follow
+the symbolic link if needed.
+
+To validate our yang modules pyang is recommended, following the 
+O-RAN Alliance data modelling guidlines.
+
+```
+pyang --lint o-ran-sc-*.yang
+```
\ No newline at end of file