Skip to content

Commit

Permalink
README: Update to current setup.py method (pip install -e)
Browse files Browse the repository at this point in the history
Signed-off-by: Gunnar Andersson <[email protected]>
  • Loading branch information
gunnar-mb committed Jan 15, 2025
1 parent d10894b commit 859e771
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,23 +132,29 @@ Note: In this case, tox takes care of calling `pip` and `setup.py` to install t

Regardless of which type of virtual environment (if any) you use, it is required to install the IFEX package into your python environment, and to install needed dependencies with pip.

0. **If you use a virtual environment, remember to first activate it!**
For example:
```
source venv/bin/activate
```

1. Install dependencies:
```
pip install -r requirements.txt
```

2. Install the IFEX provided modules into your virtual environment)
2. Install the IFEX provided modules into your virtual environment
The following installs the package in develop mode (using setup.py)
```
python setup.py develop
pip install -e .
```

## Trying it out

Installing the IFEX tools using `setup.py` creates some convenient
executable shims, e.g. `ifexgen`, `ifexgen_dbus`, `ifexconv_protobuf`, ...

If those commands are not in your environment, try setting up python virtual environment and make sure setup.py runs correctly. After that, they should be in the `$PATH` variable and possible to run.
If those commands are not in your environment, try setting up python virtual environment and make sure pip install -e (setup.py) runs correctly. After that, they should be in the `$PATH` variable and possible to run.

To run a generic code generator and specify an output template:

Expand Down

0 comments on commit 859e771

Please sign in to comment.