Skip to content

Commit

Permalink
README: Mention PYTHONPATH, reformat commands
Browse files Browse the repository at this point in the history
- Add a note about running OpenShot with an uninstalled libopenshot
  by setting PYTHONPATH.
- Replace space-indented code blocks with fenced blocks, and
  mark as `sh` code to enable syntax highlighting.
- Remove `$` prompts from shell code to make copy-pastable.
  • Loading branch information
ferdnyc committed Dec 25, 2019
1 parent 9e0b457 commit 676f004
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Expand Up @@ -54,7 +54,7 @@ instructions for getting source code, configuring dependencies, and building Ope

Beautiful HTML documentation can be generated using Sphinx.

```
```sh
cd doc
make html
```
Expand Down Expand Up @@ -97,12 +97,27 @@ dependencies in order to run OpenShot successfully:

## Launch

To run OpenShot from the command line, use the following syntax:
To run OpenShot from the command line with an installed `libopenshot`,
use the following syntax:
(be sure the change the path to match the install or repo location
of openshot-qt)

$ cd [openshot-qt folder]
$ python3 src/launch.py
```sh
cd [openshot-qt folder]
python3 src/launch.py
```

To run with a version of `libopenshot` built from source but not installed,
set `PYTHONPATH` to the location of the compiled Python bindings. e.g.:

```sh
cd [libopenshot folder]
mkdir build; cd build; cmake [options] ..; make

cd [openshot-qt folder]
PYTHONPATH=[libopenshot folder]/build/src/bindings/python \
python3 src/launch.py
```

## Websites

Expand Down

0 comments on commit 676f004

Please sign in to comment.