diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 32cb326b9..37dfa6bf9 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -14,52 +14,6 @@ $ python3 --version Python 3.8.10 ``` -## How to run OTA client on the target ECU - -Appropriate partitioning and configurations are required. See [docs/README.md](docs/README.md). - -Installation guide is available at [docs/INSTALLATION.md](docs/INSTALLATION.md). - -### Run otaclient directly - -```bash -# with virtualenv activated -python3 -m otaclient -# or -python3 -m otaclient.app -``` - -### Run otaclient installed at custom location - -If we install the otaclient to custom directory instead of the default location, we must indicate python the path to the install location. - -#### method 1: indicate path by **PYTHONPATH** - -```bash -# we have to append the /opt/ota to the PYTHONPATH, to tell the -# python interpreter to search otaclient package under /opt/ota, instead of -# using the one install under /lib/python3.8/site-packages - -# with venv activated: -PYTHONPATH=/opt/ota python3 -m otaclient -# or -PYTHONPATH=/opt/ota python3 -m otaclient.app -``` - -#### method 2: change working dir to the install location - -```bash -# change work dir to /opt/ota -cd /opt/ota - -# with venv activated: -# NOTE:python will insert current working dir at index 0 in `sys.path` -# under /opt/ota folder, so that python will first use otaclient under /opt/ota -python3 -m otaclient -# or -python3 -m otaclient.app -``` - ## How to test OTA client on the development PC ### Build the image for testing @@ -158,7 +112,7 @@ Type "help", "copyright", "credits" or "license" for more information. >>> from otaclient_pb2.v2 import otaclient_pb2_grpc ``` -### Updating docs/SERVICES.md +### Creating docs/SERVICES.md The protobuf document docs/SERVICES.md should be updated by protoc-gen-doc tool.