Skip to content

Commit

Permalink
Add standalone executable instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
JustAman62 committed May 9, 2024
1 parent fddac6c commit 184c738
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The `OpenF1.Data` library is provided to facilitate connectivity with the F1 Liv
- [Getting Started with `openf1-console`](#getting-started-with-openf1-console)
- [Installation](#installation)
- [Install and run as a dotnet tool](#install-and-run-as-a-dotnet-tool)
- [Install and run the standalone executable](#install-and-run-the-standalone-executable)
- [Run directly from Source](#run-directly-from-source)
- [Start Timing for a Live Session](#start-timing-for-a-live-session)
- [Start Timing for a Pre-recorded Session](#start-timing-for-a-pre-recorded-session)
Expand Down Expand Up @@ -50,6 +51,18 @@ openf1-console

This method is recommended as it is easy to keep the app updated using `dotnet tool update -g openf1-console`.

### Install and run the standalone executable

Standalone executables are attached to each GitHub release. Download the executable for your system OS/architecture and simply run it directly

```sh
# Download the latest executable (in this case for macos-arm64)
curl https://github.com/BrownKnight/open-f1/releases/latest/download/openf1-console-macos-arm64 -o ./openf1-console

# Execute openf1-console to start the TUI
./openf1-console
```

#### Run directly from Source

```sh
Expand Down

0 comments on commit 184c738

Please sign in to comment.