Initial source commit

[ric-plt/xapp-frame-cpp.git] / src / xapp / README

diff --git a/src/xapp/README b/src/xapp/README
new file mode 100644 (file)
index 0000000..39391b2
--- /dev/null
+++ b/src/xapp/README
@@ -0,0 +1,27 @@
+
+==================================================================================
+       Copyright (c) 2020 Nokia
+       Copyright (c) 2020 AT&T Intellectual Property.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================================
+
+This directory contains the source for the overall Xapp class.
+Specifially:
+
+       xapp.*
+               Is the class that the user creates in their application. It provides, by
+               extension, the RMR messaging functions.
+
+
+