Move version to single place; Move 'build' to User Guide; Add 'make publish'
This commit is contained in:
29
README.md
29
README.md
@@ -5,34 +5,9 @@ reconciles a running [VPP](https://fd.io/) daemon with its configuration. It is
|
||||
re-entrant and stateless. The tool connects to the VPP API and creates/removes all of the
|
||||
configuration in a minimally intrusive way.
|
||||
|
||||
***NOTE*** This code is under development, and probably won't work well until this note is removed.
|
||||
If you're interested in helping, reach out to <pim at ipng dot ch> to discuss options.
|
||||
|
||||
## Building
|
||||
|
||||
This program expects Python3 and PIP to be installed. It's known to work on Debian Bullseye and
|
||||
Bookworm, as well as on Ubuntu Focal, Jammy and Noble.
|
||||
|
||||
You can simply install this package from [[PyPi](https://pypi.org/project/vppcfg/)]:
|
||||
```
|
||||
|
||||
## Start a Virtual Environment
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
|
||||
## Install python build dependencies
|
||||
$ make install-deps
|
||||
|
||||
## Ensure all unittests pass.
|
||||
$ make test
|
||||
|
||||
## Build vppcfg
|
||||
$ make build
|
||||
|
||||
## Exit the virtual environment
|
||||
$ deactivate
|
||||
|
||||
## Install the tool with PIP
|
||||
$ make install
|
||||
$ pip install [--break-system-packages] vppcfg
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
Reference in New Issue
Block a user