| Message ID | 20220820135424.81769-1-diego.rondini@kynetics.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [SWUgenerator] README.rst: add installation instructions | expand |
On 20.08.22 15:54, Diego Rondini wrote: > Signed-off-by: Diego Rondini <diego.rondini@kynetics.com> > --- > README.rst | 15 +++++++++++++-- > 1 file changed, 13 insertions(+), 2 deletions(-) > > diff --git a/README.rst b/README.rst > index 39b52a2..3f81a20 100644 > --- a/README.rst > +++ b/README.rst > @@ -37,8 +37,8 @@ optional arguments: > Description > =========== > > -`swugenerator` is a tool running on host to create and modify SWUpdate's Update > -files (SWU). SWU file contains a meta description of the release (`sw-description`), > +``swugenerator`` is a tool running on host to create and modify SWUpdate's Update > +files (SWU). SWU file contains a meta description of the release (``sw-description``), > and swugenerator adds components to a template passed from command line. > This tool requires *openssl* to run and to sign the SWU. It is goal of the tool to fill > the gap with Yocto/OE, where SWU generation is done by classes in the meta-swupdate layer, > @@ -51,3 +51,14 @@ The tool signs the SWU and can encrypt the artifacts. The tool parses the libcon > - check if an artifact should be encrypted and encrypts it > - sign sw-description with one of the methods accepted by SWUpdate > - pack all artifacts into a SWU file > + > +Installation > +============ > + > +To install ``swugenerator`` clone the repository, and from the main project folder run pip (pip3 required): :: > + > + pip install . > + > +To uninstall: :: > + > + pip uninstall swugenerator Applied, thanks ! Best regards, Stefano Babic
diff --git a/README.rst b/README.rst index 39b52a2..3f81a20 100644 --- a/README.rst +++ b/README.rst @@ -37,8 +37,8 @@ optional arguments: Description =========== -`swugenerator` is a tool running on host to create and modify SWUpdate's Update -files (SWU). SWU file contains a meta description of the release (`sw-description`), +``swugenerator`` is a tool running on host to create and modify SWUpdate's Update +files (SWU). SWU file contains a meta description of the release (``sw-description``), and swugenerator adds components to a template passed from command line. This tool requires *openssl* to run and to sign the SWU. It is goal of the tool to fill the gap with Yocto/OE, where SWU generation is done by classes in the meta-swupdate layer, @@ -51,3 +51,14 @@ The tool signs the SWU and can encrypt the artifacts. The tool parses the libcon - check if an artifact should be encrypted and encrypts it - sign sw-description with one of the methods accepted by SWUpdate - pack all artifacts into a SWU file + +Installation +============ + +To install ``swugenerator`` clone the repository, and from the main project folder run pip (pip3 required): :: + + pip install . + +To uninstall: :: + + pip uninstall swugenerator
Signed-off-by: Diego Rondini <diego.rondini@kynetics.com> --- README.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-)