Skip to content

Commit 48a929e

Browse files
committed
doc: update tray menu docs to extend to other platforms
1 parent bf7d5a5 commit 48a929e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,15 @@ immediately](#installation) using `brew install`.
2222
| `codeflare` guides you via a series of questions. Where is your code? Where is your data? How many GPUs do you need? | You may name the set of answers you provided. We call this a **profile**. Your inner loop then becomes: `codeflare -y -p <profileName>`. The `-y` means accept all prior answers. | `codeflare` offers quick access to MLFlow, Tensorboard, and a custom dashboard that tracks the resource consumption and logs of a job. |
2323
| `codeflare` glues answers together and submits a Kubernetes job. | You can switch quickly between profiles, and even submit jobs to distinct profiles concurrently. | There is no need to fiddle with yaml files and port forwards. With a few clicks, you will get a popup dashboard window. |
2424

25-
## macOS Tray Menu
25+
## Tray Menu
2626

2727
<img align="right" width="275" src="docs/images/tray/activeruns.png">
2828

29-
If you are on macOS, you can leverage the menu that `codeflare` places
30-
in the upper right of your menubar (commonly known as a "tray"
31-
menu). From your terminal, try `codeflare hello`, and you should see a
32-
`CF` tray menu.
29+
The CodeFlare tray menu offers quick access to the most common
30+
features. On macOS and Linux, the menu will appear the upper right of
31+
your menubar, as shown in the screenshot to the right.
32+
33+
To launch the CodeFlare tray menu from your terminal, try `codeflare hello`. You should now see a `CF` tray menu.
3334

3435
## Installation
3536

0 commit comments

Comments
 (0)