aboutsummaryrefslogtreecommitdiffstats
path: root/test/mocks/netconf-pnp-simulator/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/mocks/netconf-pnp-simulator/README.md')
-rw-r--r--test/mocks/netconf-pnp-simulator/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/test/mocks/netconf-pnp-simulator/README.md b/test/mocks/netconf-pnp-simulator/README.md
new file mode 100644
index 000000000..df3211844
--- /dev/null
+++ b/test/mocks/netconf-pnp-simulator/README.md
@@ -0,0 +1,9 @@
+# NETCONF Plug-and-Play Simulator
+
+Instead of a single docker image aggregating all Yang models and simulation logic, this simulator uses a modular
+approach that is reflected on this directory structure:
+
+- engine: Contains only the core NETCONF engine and files required to build the
+ docker image;
+- modules: The modules containing the Yang models and its corresponding
+ applications goes here.