Skip to content

Commit 676f004

Browse files
authored
README: Mention PYTHONPATH, reformat commands
- 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.
1 parent 9e0b457 commit 676f004

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

+19-4
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ instructions for getting source code, configuring dependencies, and building Ope
5454

5555
Beautiful HTML documentation can be generated using Sphinx.
5656

57-
```
57+
```sh
5858
cd doc
5959
make html
6060
```
@@ -97,12 +97,27 @@ dependencies in order to run OpenShot successfully:
9797

9898
## Launch
9999

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

104-
$ cd [openshot-qt folder]
105-
$ python3 src/launch.py
105+
```sh
106+
cd [openshot-qt folder]
107+
python3 src/launch.py
108+
```
109+
110+
To run with a version of `libopenshot` built from source but not installed,
111+
set `PYTHONPATH` to the location of the compiled Python bindings. e.g.:
112+
113+
```sh
114+
cd [libopenshot folder]
115+
mkdir build; cd build; cmake [options] ..; make
116+
117+
cd [openshot-qt folder]
118+
PYTHONPATH=[libopenshot folder]/build/src/bindings/python \
119+
python3 src/launch.py
120+
```
106121

107122
## Websites
108123

0 commit comments

Comments
 (0)