From d13ae552113ee366e654534ee41040dd74dccc55 Mon Sep 17 00:00:00 2001 From: Suzanne Soy Date: Sun, 13 Mar 2022 23:37:46 +0000 Subject: [PATCH] README text around animations --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 294bbd9..064f6ac 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,19 @@ The search bar appears next to the [`What's this?`](https://wiki.freecad.org/Std ![Screenshot of the search bar, with results in its drop-down menu and extra info about the result in a separate pane](screenshot.png) +When using the search bar for the first time, it will contain only the tools of the workbenches which have already been loaded in FreeCAD. +To include results from other workbenches, select the first search result "Refresh list of tools" which will load all FreeCAD workbenches +and memorize their tools. After restarting FreeCAD, the search result will include the memorized tools, even if the workbenches have not +been loaded yet. When selecting a tool from the search results, SearchBar will attempt to automatically load the workbenches which could +have provided that tool. + ![Animation showing how to initially load all workbenches using the first entry in the search bar](animAopt.gif) + +To navigate the search results, use the up and down arrows. Typing characters will filter the results on the fly. The extended information +panel next to the search results provides further documentation about the results, e.g. Python snippets which can be copy-pasted (note: +currently a bug crashes FreeCAD if using the context menu to perform the copy, please do not use the context menu until +https://github.com/SuzanneSoy/SearchBar/issues/12 is fixed. + ![Animation showing how to navigate the search results with the up and down keys and select code examples from the results](animB2op.gif) ### Installation