Skip to content

Commit

Permalink
Merge pull request #3 from cisco-open/svrnm-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
HarrySBassi authored May 16, 2024
2 parents d74c3f8 + 6c27544 commit 5b6f8d9
Show file tree
Hide file tree
Showing 3 changed files with 182 additions and 166 deletions.
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Changelog

All notable changes to this project will be documented in this file.

22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# GNMI client

# gNMI Client Examples

[![Release](https://img.shields.io/github/v/release/cisco-ospo/oss-template?display_name=tag)](CHANGELOG.md)
[![Lint](https://github.com/cisco-ospo/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/cisco-open/gnmi-client-examples/actions/workflows/lint.yml)
Expand All @@ -18,18 +19,19 @@ To get a local copy up and running follow these simple steps.
These are all provided/handled for ease of use:

User can find the specification for gNMI here:
https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md
<https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md>

User can find information regarding open-config here:
https://github.com/openconfig/public/tree/master
<https://github.com/openconfig/public/tree/master>

User can find the protos used here (Updated protos on April 22 2024):
https://github.com/openconfig/gnmi/tree/master/proto
<https://github.com/openconfig/gnmi/tree/master/proto>
Things to do: cleanup and fetch during build
The commands used to get the protos were:
git clone <> followed by:
git checkout SHA:
```

```sh
git clone https://github.com/openconfig/gnmi.git
git checkout 5588964b559c9afee319909dd022b6706fe4a162
```
Expand All @@ -51,20 +53,26 @@ We use docker containers, which handles the installation of the required package
## Build Docker environment

1. Run the docker build

```sh
cd gnmi_client
make gnmi-build
```

2. To go into docker enviornment

```sh
make app-bash
```

3. To remake the build with any new changes, in the docker environment

```sh
$ cd src
$ make
cd src
make
```


## Usage: Gnmi Client Examples:
Following the Steps mentioned in the C++ [README](gnmi_client/src/README.md)

Expand Down
Loading

0 comments on commit 5b6f8d9

Please sign in to comment.