oak-team/oak-editor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
This README update includes clarity on the project and how to get started.
This commit is contained in:
Aaron-Mann
2019-10-13 19:21:23 -07:00
committed by GitHub
parent 7950223245
commit 9aa6c53455
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14
View File
@@ -8,12 +8,26 @@ Olive is a free non-linear video editor for Windows, macOS, and Linux.
**NOTE: The issue tracker is temporarily closed while Olive's core is getting rewritten. We apologize for any inconvenience. Please check back soon for the next release, as well as the [Patreon page](https://www.patreon.com/olivevideoeditor) for news and updates.**
## Getting Started with Olive:
Installation of Olive is available at: https://olivevideoeditor.org/download.php
Instructions on how to use Olive are available on our wiki: https://github.com/olive-editor/olive/wiki/Overview-Guide
**NOTE: Olive is Alpha Software, and it should be treated as highly unstable. Work at your own risk.**
## Support Olive:
Please consider supporting Olive:
[![Become a Patron](https://olivevideoeditor.org/img/become_a_patron_button.png)](https://www.patreon.com/olivevideoeditor)
**NOTE: It is strongly discouraged to use or compile the `master` branch in its current state as it's under heavy restructuring. Please use the 0.1.x code from the "Releases" tab instead.**
## Compiling from Source:
Compiling instructions for Windows, macOS, and Linux can be found [on the main site](https://olivevideoeditor.org/compile.php).
Olive has Doxygen-compatible documentation hosted at http://olivevideoeditor.org/doxygen/. You can also run `doxygen` in the source root directory to generate a local copy.