diff mbox series

[3/3] swupdateclient: Adjust the README.md

Message ID 20230227114929.49105-3-festevam@gmail.com
State Accepted
Headers show
Series [1/3] swupdateclient: Fix the URL entry | expand

Commit Message

Fabio Estevam Feb. 27, 2023, 11:49 a.m. UTC 
From: Fabio Estevam <festevam@denx.de>

Now that swupdateclient has its dependencies expressed in
Pipfile and in setup.py, there is no need to manually install them.

Also, the swupdateclient executable name is 'swupdateclient' now, so
update the README.md accordingly.

Signed-off-by: Fabio Estevam <festevam@denx.de>
---
 tools/python/swupdateclient/README.md | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/tools/python/swupdateclient/README.md b/tools/python/swupdateclient/README.md
index 9d7e320401cd..84e2ac355cbc 100644
--- a/tools/python/swupdateclient/README.md
+++ b/tools/python/swupdateclient/README.md
@@ -4,11 +4,12 @@  SPDX-FileCopyrightText: 2021 Blueye Robotics AS
 SPDX-License-Identifier: GPL-2.0-only
 -->
 
-## Install dependencies
+## Installing swupdateclient
 
 ### pip
 ```
-pip install websockets requests termcolor
+cd tools/python/swupdateclient
+pip3 install .
 ```
 
 ### pipenv
@@ -20,12 +21,12 @@  pipenv install
 
 ### pip
 ```
-./swupdate_client.py <path-to-swu> <host_name> [port]
+swupdateclient <path-to-swu> <host_name> [port]
 ```
 
 ### pipenv
 ```
-pipenv run ./swupdate_client.py <path-to-swu> <host_name> [port]
+pipenv run swupdateclient <path-to-swu> <host_name> [port]
 ```
 
 
@@ -43,5 +44,5 @@  else:
 
 ### Formatting
 ```
-black swupdate_client.py
+black swupdateclient
 ```