Skip to content

Commit

Permalink
Add note about ffmpeg.
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewGerber committed Jun 11, 2024
1 parent f70a212 commit 30e734d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@ alternatives.
# Installation and Use

RLAI requires `swig` and `ffmpeg` to be installed on the system. These can be installed using a package manager on your
OS (e.g., Homebrew for macOS, `apt` for Ubuntu, etc.).
OS (e.g., Homebrew for macOS, `apt` for Ubuntu, etc.). If installing with Homebrew on macOS, then you might need to add
an environment variable pointing to ffmpeg as follows:
```shell
echo 'export IMAGEIO_FFMPEG_EXE="/opt/homebrew/bin/ffmpeg"' >> ~/.bash_profile
```

The RLAI code is distributed via [PyPI](https://pypi.org/project/rlai/). There are several ways to use the package.

Expand Down
3 changes: 2 additions & 1 deletion run_configurations/meta.run.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="meta" type="PythonConfigurationType" factoryName="Python">
<module name="rlai" />
<option name="ENV_FILES" value="" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="PARENT_ENVS" value="true" />
<envs>
<env name="PYTHONUNBUFFERED" value="1" />
<env name="ANNOTATIONS_ON" value="True" />
</envs>
<option name="SDK_HOME" value="" />
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/src/rlai/meta" />
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/src/rlai/meta/" />
<option name="IS_MODULE_SDK" value="true" />
<option name="ADD_CONTENT_ROOTS" value="true" />
<option name="ADD_SOURCE_ROOTS" value="true" />
Expand Down

0 comments on commit 30e734d

Please sign in to comment.