Skip to content

chore(docs): clarify j2cli installation prerequisite #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cyw233 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore(docs): clarify j2cli installation prerequisite #223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down