README.md 5.4 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

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
[![Build Status](https://img.shields.io/travis/OpenShot/openshot-qt/develop.svg?label=openshot-qt)](https://travis-ci.org/OpenShot/openshot-qt) [![Build Status](https://img.shields.io/travis/OpenShot/libopenshot/develop.svg?label=libopenshot)](https://travis-ci.org/OpenShot/libopenshot) [![Build Status](https://img.shields.io/travis/OpenShot/libopenshot-audio/develop.svg?label=libopenshot-audio)](https://travis-ci.org/OpenShot/libopenshot-audio)

## Features

* Cross-platform (Linux, Mac, and Windows)
* Support for many video, audio, and image formats (based on FFmpeg)
* Powerful curve-based Key frame animations
* Desktop integration (drag and drop support)
* Unlimited tracks / layers
* Clip resizing, scaling, trimming, snapping, rotation, and cutting
* Video transitions with real-time previews
* Compositing, image overlays, watermarks
* Title templates, title creation, sub-titles
* 2D animation support (image sequences)
* 3D animated titles (and effects)
* SVG friendly, to create and include vector titles and credits
* Scrolling motion picture credits
* Advanced Timeline (including Drag & drop, scrolling, panning, zooming, and snapping)
* Frame accuracy (step through each frame of video)
* Time-mapping and speed changes on clips (slow/fast, forward/backward, etc...)
* Audio mixing and editing
* Digital video effects, including brightness, gamma, hue, greyscale, chroma key, and many more!
29

J
Jonathan Thomas 已提交
30
## Getting Started
31

J
Jonathan Thomas 已提交
32 33 34 35
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.
36

J
Jonathan Thomas 已提交
37
https://www.openshot.org/download/
38

J
Jonathan Thomas 已提交
39
## Tutorial
40

J
Jonathan Thomas 已提交
41
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/):
42

J
Jonathan Thomas 已提交
43
## Developers
44

J
Jonathan Thomas 已提交
45 46 47 48
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.
49

J
Jonathan Thomas 已提交
50
## Documentation
51

J
Jonathan Thomas 已提交
52
Beautiful HTML documentation can be generated using Sphinx.
53

J
Jonathan Thomas 已提交
54 55 56 57
```
cd doc
make html
```
58

J
Jonathan Thomas 已提交
59
## Report a bug
60

J
Jonathan Thomas 已提交
61 62 63
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.
64

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

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

J
Jonathan Thomas 已提交
69
## Translations
70

J
Jonathan Thomas 已提交
71 72
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.
73

74 75
* Application Translations: https://translations.launchpad.net/openshot/2.0/+translations
* Website Translations: https://translations.launchpad.net/openshot/website/+pots/django
76

J
Jonathan Thomas 已提交
77
## Dependencies
78

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

J
Jonathan Thomas 已提交
82 83 84
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: 
85

J
Jonathan Thomas 已提交
86 87 88 89 90 91
*  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 已提交
92

J
Jonathan Thomas 已提交
93
## Launch
F
Frank Dana 已提交
94

J
Jonathan Thomas 已提交
95 96 97
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)
98

J
Jonathan Thomas 已提交
99 100
    $ cd [openshot-qt folder]
    $ python3 src/launch.py
101

D
Dylan Coakley 已提交
102
## Websites
103

J
Jonathan Thomas 已提交
104
- https://www.openshot.org/  (Official website and blog)
D
DylanC 已提交
105
- https://github.com/OpenShot/openshot-qt (source code and issue tracker)
J
Jonathan Thomas 已提交
106 107 108
- 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/
109

J
Jonathan Thomas 已提交
110
## Copyright
111

J
Jonathan Thomas 已提交
112 113 114 115
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.
116

J
Jonathan Thomas 已提交
117 118 119 120
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 已提交
121

J
Jonathan Thomas 已提交
122 123 124 125
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 已提交
126

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