Skip to content

Commit 78c230a

Browse files
Finish the menu bar in depth section
1 parent 8767390 commit 78c230a

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,44 @@ Figure 2.9: Using the CircuitPython Bundle Manager to install dependencies for u
311311

312312
### The menu-bar in depth
313313

314-
Nothing here just yet!
314+
There are lots of commands in the menu-bar. Figure 2.10 shows all of them.
315+
316+
Figure 2.10: All commands in the menu-bar at the time of this writing when a project is opened.
317+
318+
![Pictures of the CircuitPython Project Manager's various menu items while a project is opened](assets/2/10.png)
319+
320+
- `File`
321+
- `New...`: Opens a dialog to create a new project. Will only be enabled if no project is opened. The keyboard
322+
shortcut is <kbd>Ctrl</kbd> + <kbd>N</kbd>. (<kbd>Cmd</kbd> + <kbd>N</kbd> for macOS users)
323+
- `Open...`: Opens a file selector prompting you to select a `.cpypmconfig` file. Will only be enabled if no
324+
project is opened. The keyboard shortcut is <kbd>Ctrl</kbd> + <kbd>O</kbd>. (<kbd>Cmd</kbd> + <kbd>O</kbd> for
325+
macOS users)
326+
- `Open recent`: Is a sub-menu listing the last 10 `.cpypmconfig` files you've opened. Will only be enabled if no
327+
project is opened.
328+
- `Clear recent projects`: Will clear all the recent projects.
329+
- `Close project`: Will close the current project. Will only be enabled if a project is opened. The keyboard
330+
shortcut is <kbd>Ctrl</kbd> + <kbd>Q</kbd>. (<kbd>Cmd</kbd> + <kbd>Q</kbd> for macOS users)
331+
- `Edit`: All these items will only be enabled if a project is opened.
332+
- `Open .cpypmconfig`: Opens the `.cpypmconfig` file in the default `.cpypmconfig` application.
333+
- `Open .cpypmconfig file location`: Opens the `.cpypmconfig` file location in the default file browser.
334+
- `Open project root file location`: Opens the project root file location in the default file browser.
335+
- `Copy project root file location`: Copies the project root file location to the clipboard.
336+
- `Save changes`: Saves the changes you made in the GUI. The keyboard shortcut is <kbd>Ctrl</kbd> + <kbd>S</kbd>.
337+
(<kbd>Cmd</kbd> + <kbd>S</kbd> for macOS users)
338+
- `Discard changes`: Discards the changes you made in the GUI. The keyboard shortcut is
339+
<kbd>Ctrl</kbd> + <kbd>D</kbd>. (<kbd>Cmd</kbd> + <kbd>D</kbd> for macOS users)
340+
- `Sync`: All these items will only be enabled if a project is opened.
341+
- `Sync files`: Syncs the files. The keyboard shortcut is <kbd>Ctrl</kbd> + <kbd>R</kbd>. (For "run")
342+
(<kbd>Cmd</kbd> + <kbd>R</kbd> for macOS users)
343+
- `Help`
344+
- `Open configuration`: Opens the configuration file in the default `.json` application.
345+
- `Open logs`: Opens the logs in the default `.log` application.
346+
- `Open README.md`: Opens the README.md file. The keyboard shortcut is <kbd>F1</kbd>
347+
- `Convert Markdown to HTML`: A checkbutton on whether to convert the markdown to HTML before opening it for you.
348+
If it is checked, the README will be opened in the default `.html` application, otherwise it will open in the
349+
default `.md` application.
350+
- `Open project on GitHub`: Opens the project on GitHub in the default browser.
351+
- `Open issue on GitHub`: Opens the new issue panel on GitHub in the default browser.
315352

316353
[Back to table of contents](#table-of-contents)
317354

assets/2/10.png

1.51 MB
Loading

assets/2/9.png

242 KB
Loading

0 commit comments

Comments
 (0)