Reorganize top-level directories with clearer naming convention

app -> app-desktop-macos, presets -> app-presets, server -> remote-server, daw-config-reaper -> osc-config-daw, plugin-reaper-realearn -> plugin-reaper-relearn. Updated run.py and presets.py path references accordingly. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-15 17:51:05 -04:00
parent e58f06d9fa
commit 7ecc718f5d
2256 changed files with 11 additions and 5 deletions
@@ -0,0 +1,9 @@
+= User interface
+
+The plug-in's native user interface features a plain and simple design.
+It mainly hosts link:https://www.helgoboss.org/projects/realearn[ReaLearn], the controller integration tool of Helgobox.
+
+include::partial$realearn-specific-ui-elements.adoc[]
+
+.Plug-in window
+image::screenshots/plugin-window.png[]
@@ -0,0 +1,58 @@
+= Menu bar
+
+include::partial$realearn-specific-ui-elements.adoc[]
+
+== Menu button
+
+This opens the main menu of Helgobox/ReaLearn.
+The same menu opens when you right-click an empty area.
+
+It provides the following general entries.
+
+[[open-pot-browser]] Open Pot Browser::
+This will open Pot Browser.
+See xref:products.adoc#pot-browser[] for details.
+
+[[show-app]] Show App::
+Shows the xref:helgobox::app.adoc[] associated with this xref:helgobox::key-concepts.adoc#instance[].
+
+[[close-app]] Close App::
+Closes the xref:helgobox::app.adoc[] associated with this xref:helgobox::key-concepts.adoc#instance[].
+
+[[server]] Server::
+Helgobox features a built-in server which allows the xref:app.adoc[] (and the old ReaLearn Companion App) to connect to Helgobox.
+The server runs globally, not per instance!
+
+[[enable-and-start-server]] Enable and start!::: This starts the server and makes sure it will automatically be started next time you use Helgobox.
+
+Disable and stop!::: This stops the server and makes sure it will not be started next time you use Helgobox.
+
+Add firewall rule::: Attempts to add a firewall rule for making the server accessible from other devices or displays instructions on how to do it.
+
+Open app folder::: Opens the folder which contains the xref:app.adoc[] (in case you want to run it in xref:app.adoc#app-remote-mode[]).
+
+[[export-to-clipboard]]
+== Export to clipboard button
+
+Pressing the export button allows you to copy Helgobox settings to the clipboard so you can import them in another instance or edit them in a link:https://en.wikipedia.org/wiki/Text_editor[text editor].
+
+--
+The following list only describes the general-purpose menu entries. For the rest, see:
+
+* xref:realearn::user-interface/main-panel/menu-bar.adoc#export-to-clipboard-button[ReaLearn entries]
+* xref:playtime::user-interface/menus/export-to-clipboard-menu.adoc[Playtime entries]
+--
+
+Export instance as JSON::
+Copies a _complete_ dump of this xref:key-concepts.adoc#instance[] to the clipboard in JSON format.
+
+[[import-from-clipboard]]
+== Import from clipboard button
+
+Pressing the import button does the opposite: It restores whatever Helgobox dump is currently in the clipboard.
+It supports JSON or Luau.
+
+[[help]]
+== Help button (?)
+
+Provides links to the reference and other documentation.
@@ -0,0 +1,63 @@
+= Welcome dialog
+
+This dialog appears once after installing Helgobox and whenever you start the action xref:reaper-actions.adoc#show-welcome-screen[].
+
+image::helgobox::screenshots/welcome-dialog.png[width=500]
+
+== Checkbox "Add Playtime button to main toolbar"
+
+Lets you enable or disable a button in the main toolbar that starts xref:playtime::introduction.adoc[Playtime].
+
+== Error checkboxes
+
+Like any other complex piece of software, Helgobox might have link:https://en.wikipedia.org/wiki/Software_bug[bugs]. There are roughly two types of bugs: _Subtle_ bugs and _detectable_ bugs. Subtle bugs are very hard to investigate. Detectable bugs, however, are "great" because they contain an error message and give me (the developer) a clue of what went wrong. This clue is crucial because I need it to fix the bug.
+
+The error checkboxes let you decide what Helgobox does if it detects a _detectable_ bug. Let's say the bug occurs. Here's what happens, depending on your configuration:
+
+[cols="1,1,4"]
+|===
+|Send errors |Show errors | Effect
+
+|Off
+|Off
+|
+A small btn:[ERR] notification will show up in the REAPER title bar (easy to miss!). When you click it, you will see only very basic information about the error.
+
+|Off
+|On
+|
+A console window will appear with detailed information about the error and a plea to send this information to the developer manually.
+
+|On
+|Off
+|
+If you are online, Helgobox will send detailed information about the error to the developer (using the third-party error tracking service https://sentry.io[Sentry], see our https://www.helgoboss.org/privacy-statement[privacy statement]). In addition, a small btn:[ERR] notification will show up in the REAPER title bar. Clicking it will reveal further instructions.
+
+If you are offline, a console window will appear with detailed information about the error and a plea to send this information to the developer manually.
+
+|On
+|On
+|
+If you are online, Helgobox will send detailed information about the error to the developer and show a console window with further instructions.
+
+If you are offline, a console window will appear with detailed information about the error and a plea to send this information to the developer manually.
+|===
+
+.Recommendation
+[TIP]
+====
+I recommend enabling both checkboxes!
+
+Sending the error automatically makes sure that I learn about the error as soon as possible, even without your manual notification (I know that you are busy with other things than reporting errors icon:smile-o[]). It also means that the error message shown in the console gets much smaller, as Helgobox then only shows an error ID instead of the full info.
+
+Showing the error in the console in addition makes sure that you don't miss that something went wrong and offers you ways how to deal with the situation. In many cases, it helps if I get further information from you, such as instructions how to reproduce the error.
+====
+
+
+IMPORTANT: Unless you have a live situation (in which case it might make sense to ignore errors), please tick at least one of the checkboxes. I can't fix bugs if I don't know about them! Thanks.
+
+== Checkbox "Notify about updates"
+
+By default, Helgobox checks on startup for available updates. If a more recent version is available, you will see a notification somewhere in the xref:helgobox::plug-in/user-interface.adoc[plug-in window] and the xref:app/user-interface.adoc[app window].
+
+If you don't want ReaLearn to check for updates, you can disable it here.