diff --git a/README.md b/README.md index fa505271..37621e0e 100644 --- a/README.md +++ b/README.md @@ -13,59 +13,60 @@ The primary dependencies to install the project are the following: There are two recommended ways of running the project: -1. Building and running the docker file: +Option number `1` has the advantage of running within Docker, where everything +is fired up automatically, including certificates generation, tests and linting. + +Also both SECC and EVCC are spawned, automatically. + +For option number `2`, the certificates need to be provided. The project includes +a script to help on the generation of -2 and -20 certificates. This script +is located under `iso15118/shared/pki/` directory and is called `create_certs.sh`. +The following command provides a helper for the script usage: + +```bash +$ ./create_certs.sh -h +``` + +Use the following commands to generate certificates for 15118-2 and 15118-20: +```bash +$ ./create_certs.sh -v iso-2 +$ ./create_certs.sh -v iso-20 +``` + +Option 1. Building and running the docker file: ```bash $ make build $ make dev ``` -2. Local Installation +Option 2. Local Installation Install JRE engine with the following command: ```bash sudo apt update && sudo apt install -y default-jre - ``` - The JRE engine is only a temporary requirement until we replace the Java-based - EXI codec (EXIficient)[^4] with our own Rust-based EXI codec. - - Install the module using `poetry` and run the main script related - to the EVCC or SECC instance you want to run. Switch to the iso15118 directory - and run: - - ```bash - $ poetry update - $ poetry install - $ python iso15118/secc/start_secc.py # or python iso15118/evcc/start_evcc.py - ``` + The JRE engine is only a requirement in Josev Community if using the Java-based + EXI codec (EXIficient)[^4]. Josev Professional uses our own Rust-based EXI codec. - For convenience, the Makefile, present in the project, helps you to run these - steps. Thus, in the terminal run: + For convenience, the Makefile, present in the project, helps you to start up SECC. Thus, in the terminal run: ```bash $ make install-local $ make run-secc ``` + + The following is a summary of what it does in the background with the above commands: + 1. Poetry update and install + 2. Runs the start script for SECC - This will call the poetry commands above and run the start script of the - secc. - -Option number `1` has the advantage of running within Docker, where everything -is fired up automatically, including certificates generation, tests and linting. - -Also both SECC and EVCC are spawned, automatically. - -For option number `2`, the certificates need to be provided. The project includes -a script to help on the generation of -2 and -20 certificates. This script -is located under `iso15118/shared/pki/` directory and is called `create_certs.sh`. -The following command provides a helper for the script usage: - -```bash -$ ./create_certs.sh -h -``` + ```bash + $ poetry update + $ poetry install + $ python iso15118/secc/start_secc.py # or python iso15118/evcc/start_evcc.py + ``` ---