Revamp documentation and add new screenshots

charlielee · Feb 21, 2021 · 4927aaa · 4927aaa
1 parent 0c521a7
commit 4927aaa
Show file tree

Hide file tree

Showing 30 changed files with 249 additions and 217 deletions.
diff --git a/docs/features/export-video.md b/docs/features/export-video.md
@@ -1,4 +1,4 @@
-# Export video
+# Export Video
 
 Captured frames can be rendered as a video file via the FFmpeg library. To render a video file, select the "Export video" option from the sidebar of the [main window](main-window.md). You must capture at least one frame for this option to be available.
 

diff --git a/docs/features/keyboard-shortcuts.md b/docs/features/keyboard-shortcuts.md
@@ -1,8 +1,8 @@
-# Keyboard shortcuts
+# Keyboard Shortcuts
 
 There are numerous keyboard shortcuts available in Boats Animator; here is a comprehensive list of all of them.
 
-!!! note "Note for macOS users:"
+!!! note "Note for macOS users"
     The `Command` key should be used in place of any shortcuts listed with `Ctrl` in them.
 
 | Action | Primary | Alternative |

diff --git a/docs/features/main-window.md b/docs/features/main-window.md
diff --git a/docs/features/menu-bar.md b/docs/features/menu-bar.md
@@ -0,0 +1,64 @@
+# Menu Bar
+
+![Menu bar](../img/menu-bar.png)
+
+The menu bar contains an assortment of options both to do with the current project and the program in general. The menu bar is located in the [Main Window](/interface/main-window)
+
+!!! note "Note for macOS users"
+    The menu bar will show some additional items to those listed here. These are automatically added by macOS.
+
+### File menu
+
+**New Project:** this feature has not been implemented yet.
+
+**Open Project:** this feature has not been implemented yet.
+
+**Main Menu:** select this to return to the [launcher window](/interface/launcher-window).
+
+**Exit:** select this to close the program.
+
+### Edit menu
+
+**Delete Last Frame:** this will remove the last frame of your animation and delete it permanently from the hard-drive. After selecting this a confirm dialogue with "Are you sure you want to delete frame X?" is displayed.
+
+### Capture menu
+
+**Capture Frame:** select this button to capture a new frame from the live-feed that is visible in capture mode.
+
+**Confirm Take:** select this to rename all of the captured frames file names to be sequential.
+
+**Play Capture Sounds:** this toggles whether a sound plays when a frame is captured.
+
+**Change Capture Destination:** select this to change the folder Boats Animator exports captured frames to.
+
+### Playback menu
+
+**Loop Playback:** toggle if playback should continue from the first frame captured when the last frame captured is reached.
+
+**Display First Frame:** this previews the first frame captured.
+
+**Display Last Frame:** this previews the last frame captured.
+
+### View menu
+
+**Toggle Developer Tools:** this opens the Electron developer tools. They are used to diagnose any issues with the application.
+
+**Actual Size:** this resets the size of the user interface if it has been changed.
+
+**Zoom In:** this increases the size of the user interface.
+
+**Zoom Out:** this decreases the size of the user interface.
+
+**Toggle Full Screen:** this sets the application to be full screen. Select this option again or use the keyboard shortcut `F11` to leave full screen.
+
+
+
+### Help menu
+
+**Documentation:** select this to view Boats Animator's [documentation](http://boatsanimator.readthedocs.org/) (the website you are currently on!).
+
+**Give Feedback:** select this to load the [issues page](https://github.com/charlielee/boats-animator/issues) of Boats Animator's GitHub repository.
+
+**View License:** select this to view Boats Animator's terms and conditions.
+
+**Official Website:** select this to visit <https://www.charlielee.uk/boats-animator>.
diff --git a/docs/features/status-bar.md b/docs/features/status-bar.md
@@ -0,0 +1,37 @@
+# Status Bar
+
+![Status bar](../img/status-bar.png)
+
+The status bar contains useful information about the current project. The status bar is located in the [Main Window](/interface/main-window)
+
+## Current frame
+
+`Frame x of y`
+
+This is an indicator of what is currently being displayed in the preview area. When in capture mode `x` is equal to one more than the number of frames currently captured. The logic here is: "once this picture is taken it will become the `x`th frame captured."
+
+## Current FPS
+
+`xx FPS`
+
+This is the frame rate that will be used to playback frames. The playback frame rate can be adjusted using the **frame rate adjuster**.
+
+## Current resolution
+
+`0000x0000` or `No camera selected`
+
+This is the current capture resolution that has been selected. `No camera selected` is displayed when a capture device is yet to be selected in the sidebar.
+
+## Current mode
+
+`x mode`
+
+This is the current mode that Boats Animator is in.
+
+### Capture mode
+
+This is when a live-feed of the selected camera is displayed in the preview area. Capture mode is accessed by selecting the **live-view button**.
+
+### Playback mode
+
+This is when a captured frame is displayed in the preview area. Preview mode can be accessed either by selecting a captured frame from the frame-reel or by selecting the play button.
diff --git a/docs/img/BA-0-8-0-screenshot-2-min.png b/docs/img/BA-0-8-0-screenshot-2-min.png
diff --git a/docs/img/BA-0-9-0-screenshot-1-min.PNG b/docs/img/BA-0-9-0-screenshot-1-min.PNG
diff --git a/docs/img/animation-toolbar.png b/docs/img/animation-toolbar.png
diff --git a/docs/img/ba-0-11-0-screenshot-1.png b/docs/img/ba-0-11-0-screenshot-1.png
diff --git a/docs/img/capture-button.png b/docs/img/capture-button.png
diff --git a/docs/img/export-video-dialog.png b/docs/img/export-video-dialog.png
diff --git a/docs/img/frame-rate-adjuster.png b/docs/img/frame-rate-adjuster.png
diff --git a/docs/img/frame-reel.png b/docs/img/frame-reel.png
diff --git a/docs/img/launcher-window.png b/docs/img/launcher-window.png
diff --git a/docs/img/launcher-window.svg b/docs/img/launcher-window.svg
diff --git a/docs/img/left-controls-capture.png b/docs/img/left-controls-capture.png
diff --git a/docs/img/left-controls-playback.png b/docs/img/left-controls-playback.png
diff --git a/docs/img/main-window.png b/docs/img/main-window.png
diff --git a/docs/img/main-window.svg b/docs/img/main-window.svg
diff --git a/docs/img/menu-bar.png b/docs/img/menu-bar.png
diff --git a/docs/img/onion-skinning-slider.png b/docs/img/onion-skinning-slider.png
diff --git a/docs/img/playback-controls.png b/docs/img/playback-controls.png
diff --git a/docs/img/preview-area.png b/docs/img/preview-area.png
diff --git a/docs/img/sidebar.png b/docs/img/sidebar.png
diff --git a/docs/img/status-bar.png b/docs/img/status-bar.png
diff --git a/docs/img/undo-last-frame.png b/docs/img/undo-last-frame.png
diff --git a/docs/index.md b/docs/index.md
@@ -7,4 +7,4 @@ If you come across a mistake with this documentation please consider [editing it
 * **Official homepage:** <https://www.charlielee.uk/boats-animator>
 * **GitHub repository:** <https://github.com/charlielee/boats-animator>
 
-![Main window](img/main-window.png)
+![Main window](img/ba-0-11-0-screenshot-1.png)
diff --git a/docs/features/launcher-window.md → docs/interface/launcher-window.md b/docs/features/launcher-window.md → docs/interface/launcher-window.md
@@ -1,9 +1,9 @@
-# Launcher window
-
-![Launcher window](../img/launcher-window.svg)
+# Launcher Window
 
 As its name suggests, the launcher window is the screen that appears after Boats Animator is launched.
 
+![Launcher window](../img/launcher-window.png)
+
 ## Project options
 
 ### New project