Skip to content

Commit 1a26e21

Browse files
authored
[doc]: Update README.md (sonic-net#1122)
1 parent d21feed commit 1a26e21

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

+25-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
[![Total alerts](https://img.shields.io/lgtm/alerts/g/Azure/sonic-sairedis.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Azure/sonic-sairedis/alerts/)
2-
[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/Azure/sonic-sairedis.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Azure/sonic-sairedis/context:cpp)
1+
*static analysis:*
32

4-
VS[![Build Status](https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/sonic-sairedis-build/badge/icon)](https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/sonic-sairedis-build/)
3+
[![Total alerts](https://img.shields.io/lgtm/alerts/g/sonic-net/sonic-sairedis.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/sonic-net/sonic-sairedis/alerts/)
4+
[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/sonic-net/sonic-sairedis.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/sonic-net/sonic-sairedis/context:cpp)
5+
6+
*sairedis builds:*
7+
8+
[![master build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=master&label=master)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=master)
9+
[![202205 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202205&label=202205)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202205)
10+
[![202111 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202111&label=202111)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202111)
11+
[![202106 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202106&label=202106)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202106)
12+
[![202012 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202012&label=202012)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202012)
13+
[![201911 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=201911&label=201911)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=201911)
514

615
# SONiC - SAI Redis - sairedis
716

817
## Description
9-
The SAI Redis provides a SAI redis service that built on top of redis database. It contains two major components, 1) a SAI library
10-
that puts SAI objects into the redis database, 2) a syncd that takes the SAI objects and puts them into the ASIC.
18+
19+
The SAI Redis provides a SAI redis service built on top of redis database. It contains two major components:
20+
21+
1) `SAI library` that puts SAI objects into the redis database.
22+
2) `syncd` that takes the SAI objects and puts them into the ASIC.
1123

1224
## Getting Started
1325

@@ -38,7 +50,7 @@ For your convenience, you can install prepared packages on Debian Jessie:
3850

3951
#### Install from Source
4052

41-
Checkout the source: `git clone https://github.com/Azure/sonic-sairedis.git` and install it yourself.
53+
Checkout the source: `git clone https://github.com/sonic-net/sonic-sairedis.git` and install it yourself.
4254

4355
You will also need SAI submodule: `git submodule update --init --recursive`
4456

@@ -51,7 +63,7 @@ Install prerequisite packages:
5163

5264
sudo apt-get install libswsscommon libswsscommon-dev libhiredis-dev libzmq3-dev libpython-dev
5365

54-
Note: libswsscommon-dev requires libnl-3-200-dev, libnl-route-3-200-dev and libnl-nf-3-200-dev version >= 3.5.0. If these are not available via apt repositories, you can get them from the latest sonic-buildimage Jenkins build: https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/buildimage-vs-all/lastSuccessfulBuild/artifact/target/debs/buster/.
66+
> Note: libswsscommon-dev requires libnl-3-200-dev, libnl-route-3-200-dev and libnl-nf-3-200-dev version >= 3.5.0. If these are not available via apt repositories, you can get them from the latest [sonic-buildimage build](https://sonic-build.azurewebsites.net/api/sonic/artifacts?branchName=master&platform=vs&format=zip&target=target%2Fdebs%2Fbuster).
5567
5668
Install SAI dependencies:
5769

@@ -76,13 +88,17 @@ If you do not have libsai, you can build a debian package using:
7688
## Need Help?
7789

7890
For general questions, setup help, or troubleshooting:
79-
- [sonicproject on Google Groups](https://groups.google.com/d/forum/sonicproject)
91+
92+
- [sonicproject on Google Groups](https://groups.google.com/g/sonicproject)
8093

8194
For bug reports or feature requests, please open an Issue.
8295

8396
## Contribution guide
8497

85-
See the [contributors guide](https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md) for information about how to contribute.
98+
See the [contributors guide](https://github.com/sonic-net/SONiC/wiki/Becoming-a-contributor) for information about how to contribute.
99+
100+
All contributors must sign an [Individual Contributor License Agreement (ICLA)](https://docs.linuxfoundation.org/lfx/easycla/v2-current/contributors/individual-contributor) before contributions can be accepted. This process is managed by the [Linux Foundation - EasyCLA](https://easycla.lfx.linuxfoundation.org/) and automated
101+
via a GitHub bot. If the contributor has not yet signed a CLA, the bot will create a comment on the pull request containing a link to electronically sign the CLA.
86102

87103
### GitHub Workflow
88104

@@ -116,4 +132,3 @@ For example:
116132
* Push your changes to your private fork and do "pull-request" to this repository
117133
* Use a pull request to do code review
118134
* Use issues to keep track of what is going on
119-

0 commit comments

Comments
 (0)