Skip to content

Commit

Permalink
Updated Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
latenitefilms committed Dec 24, 2023
1 parent 9e7b1b6 commit 474098b
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 6 deletions.
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

> Metaburner Pro is currently in **early development**.
>
> If you're interested in helping with development, you can sign up to **TestFlight** [here](https://testflight.apple.com/join/dw7S2veN).
> If you're interested in helping with development, you can learn more [here](/how-to-use/).
You can access it via a **Title** in the Titles sidebar.

Expand All @@ -23,6 +23,8 @@ You can even stack multiple Metaburner Pro Titles on top of each other for UNLIM

You can import your Final Cut Pro project/timeline back into the Metaburner Pro Title via a drop zone, so Metaburner Pro has full access to everything that's in the FCPXML.

There's also a Lua scripting environment built-in, so you can even "code" your own text!

Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburnerpro/discussions)!

Found a bug? Post about it on our [Issues page](https://github.com/latenitefilms/metaburnerpro/issues).
Expand Down
2 changes: 1 addition & 1 deletion docs/buy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Metaburner Pro is still in **early development**, and not yet for sale. We hope to release in late 2023.

> If you're interested in helping with development, you can sign up to **TestFlight** [here](https://testflight.apple.com/join/dw7S2veN).
> If you're interested in helping with development, you can learn more [here](/how-to-use/).
<!--
> [:icon-desktop-download: **Buy on the Mac App Store**](https://apps.apple.com/us/app/metaburner-pro/id6474466386)
Expand Down
18 changes: 17 additions & 1 deletion docs/credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,20 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.

---

## lua4swift

We use [lua4swift](https://github.com/kos-pomfort/lua4swift) by [Steven Degutis](https://github.com/SwiftyLua) and improvements by [Konstantin Silbermann](https://github.com/kos-pomfort).

Released under MIT license.

Copyright (c) 2015 Steven Degutis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
16 changes: 13 additions & 3 deletions docs/how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Metaburner Pro is currently in **early development**.

If you're interested in helping with development, you can sign up to **TestFlight** [here](https://testflight.apple.com/join/dw7S2veN).
If you're interested in helping with development, you can sign up to **TestFlight** (Apple's beta-testing service) for free [here](https://testflight.apple.com/join/dw7S2veN).

Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburnerpro/discussions)!

Expand All @@ -14,9 +14,9 @@ Found a bug? Post about it on our [Issues page](https://github.com/latenitefilms

### Known Issues & Limitations

#### Metaburner Pro v1.0.0 (Build 11)
#### Metaburner Pro v1.0.0 (Build 14)

**23rd December 2023**
**25th December 2023**

- When using the **Primary Storyline** Content Source, sometimes the first frame of an [`asset-clip`'s](https://developer.apple.com/documentation/professional_video_applications/fcpxml_reference/story_elements/asset-clip) will display no data. This is a bug.
- The **Preset** buttons currently don't do anything. This will be added in a future beta.
Expand All @@ -43,6 +43,14 @@ You can find any crash logs here:
~/Library/Logs/DiagnosticReports
```

The crash logs will have file names like `Metaburner Pro Renderer-2023-12-24-103301.ips`. They might also be in the `Retired` sub-folder (these are reports that have already been posted to Apple).

You can access your User Library, by clicking on your **Desktop**, then holding down **OPTION** as you click the **Go** menu item in Finder. A **Library** option will appear:

![](static/finder-library.png)

You can also copy the above paths, press **COMMAND+SHIFT+G** from Finder (or via the **Go > Go to Folder...** menubar item), and paste in that path into the **Go to Folder** popup.

---

### Installing
Expand Down Expand Up @@ -79,6 +87,8 @@ After installing the Motion Template, you can find the Metaburner Pro Title at t

### Title Inspector

_**As Metaburner Pro is iterating rapidly, some of the below documentation may be out-of-date as we quickly push out new beta's.**_

Simply add the Metaburner Pro Title to the top of your timeline as an adjustment layer.

It should start at the very start of your timeline.
Expand Down
Binary file added docs/static/finder-library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/metaburner-pro-screenshot.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 474098b

Please sign in to comment.