From 9aa6c534552db800d91557a425996bdda3a605ed Mon Sep 17 00:00:00 2001 From: Aaron-Mann <46825032+Aaron-Mann@users.noreply.github.com> Date: Sun, 13 Oct 2019 19:21:23 -0700 Subject: [PATCH] Update README.md This README update includes clarity on the project and how to get started. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 379735ba7..faf62793f 100644 --- a/README.md +++ b/README.md @@ -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.