From 823f4c2b8ca59f910f694eac839c109a25c46e6c Mon Sep 17 00:00:00 2001 From: chenyangwang Date: Mon, 27 Apr 2026 04:05:15 +0000 Subject: [PATCH] chore(docs): clarify j2cli installation prerequisite Signed-off-by: chenyangwang --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12e8de04..34826422 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,28 @@ This repo contains scripts, Makefiles, configuration file, Docker files etc to ``` sudo apt-get install -y make automake autoconf sudo apt install -y python3-pip -sudo pip3 install j2cli ``` + * Confirm whether `j2cli` is already installed: + +``` +j2 --version +``` + +If `j2` is not found, install `j2cli` using one of the following methods: + +``` +sudo apt install -y j2cli +``` + +or: + +``` +pip3 install --user j2cli +``` + +If you install `j2cli` with `pip3 --user`, make sure your user's local binary directory (for example, `$HOME/.local/bin`) is in your `PATH`. + * Install [Docker](https://docs.docker.com/engine/install/) and configure your system to allow running the 'docker' command without 'sudo': * Add current user to the docker group: `sudo gpasswd -a ${USER} docker` * Log out and log back in so that your group membership is re-evaluated