updated README.md

This commit is contained in:
Dmitry Toptygin
2020-04-10 18:15:32 -04:00
parent 23240d8b01
commit 65e76bb4e4

View File

@@ -1,4 +1,4 @@
# tip-wlan-opensync-protobuf
# wlan-cloud-opensync-protobuf
The scripts in this repository produce maven artifact that has all the java classes generated from the opensync protobuf definitions.
The protobuf files are taken from [Opensync repo](https://github.com/plume-design/opensync/tree/master/interfaces)
@@ -7,13 +7,13 @@ Build instructions
* make sure java jdk 9+ is installed
* make sure maven is installed
* make sure protoc version 2.6.1 is installed
* configure maven settings.xml with repository credentials
* configure maven settings.xml with maven repository credentials
* vim ~/.m2/settings.xml
```
<settings>
<servers>
<server>
<id>io.cloudrepo</id>
<id>tip-wlan-cloud-maven-repo</id>
<username>repo_user</username>
<password>password</password>
</server>
@@ -40,4 +40,12 @@ Build instructions
```
* $ mvn clean install
Results are in tip-wlan-opensync-protobuf/target/tip-wlan-opensync-protobuf-0.0.1-SNAPSHOT.jar
Results of the build will be in wlan-cloud-opensync-protobuf/target/tip-wlan-opensync-protobuf-0.0.1-SNAPSHOT.jar
They are also published in the maven repository tip-wlan-cloud-maven-repo, and can be included as maven dependencies:
```
<dependency>
<groupId>com.telecominfraproject.wlan</groupId>
<artifactId>tip-wlan-opensync-protobuf</artifactId>
<version>${tip-wlan-cloud.release.version}</version>
</dependency>
```