Added initial documentation pass

latenitefilms · Nov 21, 2023 · 8640bb0 · 8640bb0
1 parent 786378a
commit 8640bb0
Show file tree

Hide file tree

Showing 25 changed files with 149 additions and 22 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,17 +1,17 @@
 # Recall Toolbox
 
 !!!
-**NOTE:** Recall Toolbox has **not yet** been released on the Mac App Store. It's a work-in-progress.
+**Recall Toolbox** is currently waiting for approval on the Mac App Store.
 
-However, if you want to test an **early beta** via TestFlight, click [here](https://testflight.apple.com/join/FQTM8nUS).
-
-It's currently a work-in-progress, and things may change considerably prior to public release.
+In the meantime, you can access via TestFlight [here](https://testflight.apple.com/join/FQTM8nUS).
 !!!
 
 Recall Toolbox is a **Final Cut Pro Workflow Extension** that acts as a Shared Pasteboard.
 
 **Anything that you can copy and paste in Final Cut Pro, Recall Toolbox can store.**
 
+You can even drag-and-drop clips and projects from the Final Cut Pro Browser, and link to files (such as logos on a shared drive).
+
 > [:icon-desktop-download: **Click here to buy on the Mac App Store**](/buy/)
 
 ![Recall Toolbox Workflow Extension](/static/frontpage.png)
@@ -32,14 +32,12 @@ Recall Toolbox feels like a natural extension to Final Cut Pro, with a similar l
 
 ### iCloud Sync
 
-Recall Toolbox automatically syncs to ALL your devices on the same iCloud account automagically!
+Recall Toolbox automagically syncs to ALL your devices on the same iCloud account!
 
 ---
 
 ### iCloud Sharing
 
 You can share folders with other iCloud users, and control permissions. For example, you could have a "read only" folder that contains client logos for a current job!
 
-> [:icon-desktop-download: **Click here to buy on the Mac App Store**](https://apps.apple.com/us/app/recall-toolbox/id6449526499)
-
 You can learn how to use [here](https://recalltoolbox.io/how-to-use/).
diff --git a/docs/buy.md b/docs/buy.md
@@ -1,14 +1,12 @@
 # Buy on Mac App Store
 
 !!!
-**NOTE:** Recall Toolbox has **not yet** been released on the Mac App Store.
+**Recall Toolbox** is currently waiting for approval on the Mac App Store.
 
-However, if you want to test an **early beta** via TestFlight, click [here](https://testflight.apple.com/join/FQTM8nUS).
-
-It's currently a work-in-progress, and things may change considerably prior to public release.
+In the meantime, you can access via TestFlight [here](https://testflight.apple.com/join/FQTM8nUS).
 !!!
 
-> [:icon-desktop-download: **One day you'll be able to buy here on the Mac App Store**](https://apps.apple.com/us/app/recall-toolbox/id6448816971)
+> [:icon-desktop-download: **Buy on the Mac App Store**](https://apps.apple.com/us/app/recall-toolbox/id6448816971)
 
 **Recall Toolbox** is a one-time payment of **29.99**.
 

diff --git a/docs/how-to-use.md b/docs/how-to-use.md
@@ -1,3 +1,141 @@
 # How To Use
 
-This page will be updated as we get closer to a public release of the application. Stay tuned!
+### Installation
+
+You can download Recall Toolbox from the Mac App Store [here](https://apps.apple.com/us/app/recall-toolbox/id6448816971).
+
+When you run Recall Toolbox for the first time, it will load the Menu Bar icon:
+
+![](/static/menubar.png)
+
+You can easily access Recall Toolbox from the Menu Bar icon at any time:
+
+![](/static/menubar-fresh-install.png)
+
+You can also access Recall Toolbox directly in Final Cut Pro as a Workflow Extension.
+
+You can find it in the Workflow Extension button:
+
+![](/static/workflow-extension-button.png)
+
+You can also find it in the Workflow Extension menu:
+
+![](/static/workflow-extension-menu.png)
+
+The Menu Bar version of the application and the Workflow Extension version are independent, sandboxed versions of the same application, and also use iCloud to share information between each other.
+
+---
+
+### Accessibility Permission
+
+Recall Toolbox requires Accessibility Permission to trigger the Paste command in Final Cut Pro.
+
+The first time you double click a saved Item in Recall Toolbox you'll be presented with this macOS alert:
+
+![](/static/accessibility-permission.png)
+
+You should click **Open System Settings**.
+
+You'll then be presented with:
+
+![](/static/accessibility-system-prefs.png)
+
+You should click the grey toggle next to Recall Toolbox to enable Accessibility Permissions.
+
+Once enabled, Recall Toolbox will be able to trigger the Paste shortcut key in Final Cut Pro.
+
+---
+
+### Folders
+
+Recall Toolbox is very simple - on the left sidebar you have a list of **Folders**, and within each Folder you have a list of **Items**.
+
+You can click the **New Folder** Item in the bottom left corner to create a new folder:
+
+![](/static/new-folder.png)
+
+Once a Folder is created, you can right-click on it to **Rename** it.
+
+![](/static/rename-folder.png)
+
+You can delete Folders by clicking the **Remove Folder** button in the bottom left:
+
+![](/static/remove-folder.png)
+
+You can rename Folders by right-clicking on the Folder and selecting **Rename**.
+
+---
+
+### Items
+
+Once you have created a **Folder**, you can now populate it with **Items**.
+
+The easiest way to create an item is to copy something in Final Cut Pro (for example, a Title in your project/timeline), then with a Folder selected, press the *New Item** button:
+
+![](/static/new-item.png)
+
+If you have nothing in the Final Cut Pro Pasteboard, you'll be presented with this alert:
+
+![](/static/empty-pasteboard.png)
+
+Once you create a New Item:
+
+![](/static/create-new-item.png)
+
+You'll be presented with a confirmation alert:
+
+![](/static/new-item-created.png)
+
+Anything that can be copied in Final Cut Pro, can be saved in Recall Toolbox.
+
+You can also drag-and-drop items from the Final Cut Pro Browser to Recall Toolbox, and it will save those items as FCPXML data.
+
+You can also drag-and-drop files from Finder (or other applications) to Recall Toolbox, and it will save **links** to those files - meaning it just saves the file path, not the actual file data. This can be useful if you have Shared Storage, and you want to save common assets in Recall Toolbox to be shared between multiple machines.
+
+Every item can also have it's own thumbnail. Simply drag an image from Finder (or other applications) into an Item to update the thumbnail.
+
+You can also right-click on an Item to access the contextual menu:
+
+![](/static/item-menu.png)
+
+**Copy Item to Pasteboard** allows you to copy an Item to the Pasteboard without triggering a Paste in Final Cut Pro.
+
+**Rename Label** allows you to rename the Item.
+
+**Browse Thumbnail** allows you to select a new Thumbnail.
+
+**Replace Item with Pasteboard Contents** allows you to replace the Item's contents with whatever is on the Final Cut Pro Pasteboard.
+
+---
+
+### Sharing Folders
+
+If you want to share a Folder with other iCloud users, simply select the Folder you want to share, and press the **Share** button.
+
+You'll be presented with this, whist the initial sharing takes place:
+
+![](/static/sharing-in-progress.png)
+
+Once the Folder has been shared, you can press the **Share** button again to add the email addresses of other iCloud users you want to share the folder with:
+
+![](/static/share-options.png)
+
+---
+
+### Sandboxing
+
+The Menu Bar version of the application and the Workflow Extension version are independent, sandboxed versions of the same application, and also use iCloud to share information between each other.
+
+This means that if you drag a file from Finder to the Menu Bar version of Recall Toolbox, only the Menu Bar version has access to that file - the Workflow Extension does not.
+
+This is the same for if you're sharing a File between multiple machines - due to macOS sandboxing, you need to give Recall Toolbox explicit permission to access those files on each machine.
+
+When a file can't be accessed, the File tag background will be red:
+
+![](/static/file-offline.png)
+
+However, to solve this, in the Workflow Extension, you can use press the **Settings** icon and then **Grant Sandbox Access** to the folder or drive which contains the folder.
+
+![](/static/sandbox-access.png)
+
+There's also the option to **Reset Sandbox Access** to revoke permission to any locations you've previously granted it permission too.
diff --git a/docs/other-tools.md b/docs/other-tools.md
@@ -12,14 +12,6 @@ You can learn more at [commandpost.io](https://commandpost.io)
 
 ---
 
-### Transfer Toolbox
-
-**Transfer Toolbox** allows you to convert Final Cut Pro (for Mac) libraries into Final Cut Pro (for iPad) projects.
-
-You can learn more at [transfertoolbox.io](https://transfertoolbox.io)
-
----
-
 ### BRAW Toolbox
 
 **BRAW Toolbox** allows you to import Blackmagic RAW files directly into Final Cut Pro without transcoding.

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,6 +1,5 @@
 # Release Notes
 
-
 ### 1.0.0 (1)
 
 **🎉 Released:**

diff --git a/docs/static/accessibility-permission.png b/docs/static/accessibility-permission.png
diff --git a/docs/static/accessibility-system-prefs.png b/docs/static/accessibility-system-prefs.png
diff --git a/docs/static/create-new-item.png b/docs/static/create-new-item.png
diff --git a/docs/static/empty-pasteboard.png b/docs/static/empty-pasteboard.png
diff --git a/docs/static/file-offline.png b/docs/static/file-offline.png
diff --git a/docs/static/item-menu.png b/docs/static/item-menu.png
diff --git a/docs/static/menubar-fresh-install copy.png b/docs/static/menubar-fresh-install copy.png
diff --git a/docs/static/menubar-fresh-install.png b/docs/static/menubar-fresh-install.png
diff --git a/docs/static/menubar.png b/docs/static/menubar.png
diff --git a/docs/static/new-folder.png b/docs/static/new-folder.png
diff --git a/docs/static/new-item-created.png b/docs/static/new-item-created.png
diff --git a/docs/static/new-item.png b/docs/static/new-item.png
diff --git a/docs/static/remove-folder.png b/docs/static/remove-folder.png
diff --git a/docs/static/rename-folder.png b/docs/static/rename-folder.png
diff --git a/docs/static/sandbox-access.png b/docs/static/sandbox-access.png
diff --git a/docs/static/share-options.png b/docs/static/share-options.png
diff --git a/docs/static/sharing-in-progress.png b/docs/static/sharing-in-progress.png
diff --git a/docs/static/workflow-extension-button.png b/docs/static/workflow-extension-button.png
diff --git a/docs/static/workflow-extension-menu.png b/docs/static/workflow-extension-menu.png
diff --git a/docs/system-requirements.md b/docs/system-requirements.md
@@ -2,4 +2,6 @@
 
 Recall Toolbox requires **Final Cut Pro 10.6.5** or later.
 
+iCloud Sharing requires an Apple ID, and an active Internet Connection.
+
 You can find Final Cut Pro's system requirements [here](https://www.apple.com/au/final-cut-pro/specs/).