Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README file and some patterns to .gitignore #8

Merged
merged 2 commits into from Oct 2, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitignore
@@ -1 +1,12 @@
shotcut.pro.user
*.o
*.so
ui_*.h
qrc_*.cpp
moc_*.cpp
*.prl
*.a
Makefile
*.cache
src/shotcut
*.user
61 changes: 61 additions & 0 deletions README.md
@@ -0,0 +1,61 @@
# Shotcut - a free, open source, cross-platform **video editor**

- Features: http://www.shotcut.org/bin/view/Shotcut/Features
- Roadmap: http://www.shotcut.org/bin/view/Shotcut/Roadmap

## Install

**Warning**: Shotcut is currently in very early stage and active development. So do not expect a final product for now.

Binaries are regularly build and are available at http://www.shotcut.org, on the Download section.

## Contributors

- Dan Dennedy <<http://www.dennedy.org>> : main author
- Brian Matherly <<pez4brian@yahoo.com>> : contributor

## Dependencies

- [MLT](http://www.mltframework.org/): multimedia authoring framework
- [Qt 5](http://qt-project.org/): application and UI framework
- [FFmpeg](http://www.ffmpeg.org/): multimedia format and codec libraries
- [x264](http://www.videolan.org/developers/x264.html): H.264 encoder
- [WebM](http://www.webmproject.org/): VP8 encoder
- [LAME](http://lame.sourceforge.net/): MP3 encoder
- [Frei0r](http://www.dyne.org/software/frei0r/): video plugins
- [LADSPA](http://www.ladspa.org/): audio plugins

## Licence

GPLv3. See [COPYING](COPYING).

## How to build

**Warning**: building shotcut should only be reserved to beta testers or contributors who know what they are doing.

### Qt Creator

The fastest way to build and try Shotcut dev version is probably using [Qt Creator](http://qt-project.org/downloads#qt-creator).

### From command line

First, check dependencies are satisfied and various paths correctly set to find different libraries and include files (Qt 5, MLT, Frei0r and so forth).

Build `Makefile`:

```
qmake PREFIX=/usr/local/
```
Compile `shotcut`:

```
make
```

`make install` is partially working.

Best way to tesst `shotcut` is to execute it from source folder:

```
./src/shotcut
```