Add readme and metadata, no functional change

Added top-level README with text from wiki.
Added git attributes file.

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: I4d5c0fc782d60cba0340a90ae27b4eec0733fade

diff --git a/.gitattributes b/.gitattributes
new file mode 100644 (file)
index 0000000..d4628c1
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,25 @@
+# https://help.github.com/articles/dealing-with-line-endings/
+
+# Set the default behavior, in case people don't have core.autocrlf set.
+*        text=auto
+
+# Explicitly declare text files you want to always be normalized
+# and converted to native line endings on checkout.
+*.c      text diff=cpp
+*.cpp    text diff=cpp
+*.css    text
+*.go     text diff=golang
+*.htm    text diff=html
+*.html   text diff=html
+*.java   text diff=java
+*.js     text
+*.jsp    text
+*.less   text
+*.properties text
+*.py     text diff=python
+*.sql    text
+*.xml    text
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary

diff --git a/Dockerfile b/Dockerfile
index 7241441..be8d8da 100644 (file)
--- a/Dockerfile
+++ b/Dockerfile
@@ -14,14 +14,19 @@
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 # ==================================================================================
+
+# CI to build a Docker image with the A1 mediator
+# Adds gcc and cmake to build RMr library
+
 FROM python:3.7
 
 ADD . /tmp
 
-# Install RMR
+# Install RMr
 RUN apt-get update && apt-get install -y gcc git cmake
 RUN git clone https://gerrit.oran-osc.org/r/ric-plt/lib/rmr
 WORKDIR rmr
+# This pins RMr to a known working version
 RUN git checkout 68d09fa5028e47e763c44c30647da31e77eda64a
 RUN mkdir .build; cd .build; cmake ..; make install
 

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..943c194
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# RIC A1 Mediator
+
+The xApp A1 mediator exposes a generic REST API by which xApps can
+receive and send northbound messages.  The A1 mediator will take
+the payload from such generic REST messages, validate the payload,
+and then communicate the payload to the xApp via RMR messaging.
+
+Please see documentation in the docs/ subdirectory.

diff --git a/container-tag.yaml b/container-tag.yaml
index 145b8aa..fe6847c 100644 (file)
--- a/container-tag.yaml
+++ b/container-tag.yaml
@@ -1,2 +1,4 @@
+# The Jenkins job uses this string for the tag in the image name
+# for example nexus3.o-ran-sc.org:10004/my-image-name:my-tag
 ---
 tag: 0.8.2