README.md 4.0 KB
Newer Older
J
Jonathan Thomas 已提交
1 2 3
OpenShot Video Editor is an award-winning free and open-source video editor 
for Linux, Mac, and Windows, and is dedicated to delivering high quality 
video editing and animation solutions to the world.
4

J
Jonathan Thomas 已提交
5
## Build Status
6

J
Jonathan Thomas 已提交
7
[![Build Status](https://travis-ci.org/OpenShot/openshot-qt.svg?branch=develop)](https://travis-ci.org/OpenShot/openshot-qt)
8

J
Jonathan Thomas 已提交
9
## Getting Started
10

J
Jonathan Thomas 已提交
11 12 13 14
The quickest way to get started using OpenShot is to download one of 
our pre-built installers. On our download page, click the **Daily Builds** 
button to view the latest, experimental builds, which are created for each 
new commit to this repo.
15

J
Jonathan Thomas 已提交
16
https://www.openshot.org/download/
17

J
Jonathan Thomas 已提交
18
## Tutorial
19

J
Jonathan Thomas 已提交
20
Watch the official [step-by-step video tutorial](https://www.youtube.com/watch?list=PLymupH2aoNQNezYzv2lhSwvoyZgLp1Q0T&v=1k-ISfd-YBE), or read the official [user-guide](https://www.openshot.org/user-guide/):
21

J
Jonathan Thomas 已提交
22
## Developers
23

J
Jonathan Thomas 已提交
24 25 26 27
Are you interested in becoming more involved in the development of 
OpenShot? Build exciting new features, fix bugs, make friends, and become a hero! 
Please read the [step-by-step](https://github.com/OpenShot/openshot-qt/wiki/Become-a-Developer) 
instructions for getting source code, configuring dependencies, and building OpenShot.
28

J
Jonathan Thomas 已提交
29
## Documentation
30

J
Jonathan Thomas 已提交
31
Beautiful HTML documentation can be generated using Sphinx.
32

J
Jonathan Thomas 已提交
33 34 35 36
```
cd doc
make html
```
37

J
Jonathan Thomas 已提交
38
## Report a bug
39

J
Jonathan Thomas 已提交
40 41 42
Please report bugs using the official [Report a Bug](https://www.openshot.org/issues/new/) 
feature on our website. This walks you through the bug reporting process, and helps 
to create a high-quality bug report for the OpenShot community.
43

J
Jonathan Thomas 已提交
44
Or you can report a new issue directly on GitHub:
45

J
Jonathan Thomas 已提交
46
https://github.com/OpenShot/openshot-qt/issues
47

J
Jonathan Thomas 已提交
48
## Translations
49

J
Jonathan Thomas 已提交
50 51
Translating OpenShot into other languages is very easy! Please read the [step-by-step](https://github.com/OpenShot/openshot-qt/wiki/Become-a-Translator) instructions or login to LaunchPad and get started.
All you need is a web browser.
52

J
Jonathan Thomas 已提交
53
https://translations.launchpad.net/openshot/2.0/+translations
54

J
Jonathan Thomas 已提交
55
## Dependencies
56

J
Jonathan Thomas 已提交
57 58
Although installers are much easier to use, if you must build from 
source, here are some tips: 
59

J
Jonathan Thomas 已提交
60 61 62
OpenShot is programmed in Python (version 3+), and thus does not need
to be compiled to run. However, be sure you have the following 
dependencies in order to run OpenShot successfully: 
63

J
Jonathan Thomas 已提交
64 65 66 67 68 69
*  Python 3.0+ (http://www.python.org)
*  PyQt5 (http://www.riverbankcomputing.co.uk/software/pyqt/download5)
*  libopenshot: OpenShot Library (https://github.com/OpenShot/libopenshot)
*  libopenshot-audio: OpenShot Audio Library (https://github.com/OpenShot/libopenshot-audio)
*  FFmpeg or Libav (http://www.ffmpeg.org/ or http://libav.org/)
*  GCC build tools (or MinGW on Windows)
F
Frank Dana 已提交
70

J
Jonathan Thomas 已提交
71
## Launch
F
Frank Dana 已提交
72

J
Jonathan Thomas 已提交
73 74 75
To run OpenShot from the command line, use the following syntax:
(be sure the change the path to match the install or repo location 
of openshot-qt)
76

J
Jonathan Thomas 已提交
77 78
    $ cd [openshot-qt folder]
    $ python3 src/launch.py
79

D
Dylan Coakley 已提交
80
## Websites
81

J
Jonathan Thomas 已提交
82
- https://www.openshot.org/  (Official website and blog)
D
DylanC 已提交
83
- https://github.com/OpenShot/openshot-qt (source code and issue tracker)
J
Jonathan Thomas 已提交
84 85 86
- https://github.com/OpenShot/libopenshot-audio (source code for audio library)
- https://github.com/OpenShot/libopenshot (source code for video library)
- https://launchpad.net/openshot/
87

J
Jonathan Thomas 已提交
88
## Copyright
89

J
Jonathan Thomas 已提交
90 91 92 93
Copyright (c) 2008-2019 OpenShot Studios, LLC. This file is part of
OpenShot Video Editor (https://www.openshot.org), an open-source project
dedicated to delivering high quality video editing and animation solutions
to the world.
94

J
Jonathan Thomas 已提交
95 96 97 98
OpenShot Video Editor is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
D
DylanC 已提交
99

J
Jonathan Thomas 已提交
100 101 102 103
OpenShot Video Editor is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
D
DylanC 已提交
104

J
Jonathan Thomas 已提交
105 106
You should have received a copy of the GNU General Public License
along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.