From 07a4e26bf135e3315a0978e1647a8cfb16fb35e5 Mon Sep 17 00:00:00 2001 From: Joe LeVeque Date: Sat, 26 Sep 2020 07:59:28 -0700 Subject: [PATCH] [README.md] Describe new package creation schema (#1131) * [README.md] Describe new package creation schema --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 62503b4fab..56abf56529 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,34 @@ Command-line utilities for SONiC -## How to run unit test -```python -python2 -m py.test -v +This repository produces two packages, as follows: + +### sonic-utilities + +A Python wheel package, containing all the Python source code for the command-line utilities + +#### To build + +``` +python2 setup.py bdist_wheel +``` + +#### To run unit tests + ``` +python2 setup.py test +``` + + +### sonic-utilities-data + +A Debian package, containing data files needed by the utilities (bash_completion files, Jinja2 templates, etc.) + +#### To build + +Instructions for building the sonic-utilities-data package can be found in [sonic-utilities-data/README.md](https://github.com/Azure/sonic-utilities/blob/master/sonic-utilities-data/README.md) + +--- ## Contribution guide