Skip to content

Commit

Permalink
Update the readme for Windows installation
Browse files Browse the repository at this point in the history
  • Loading branch information
elkanamol committed Sep 1, 2024
1 parent c05b64b commit 917955a
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# em-mc_status_script
# sierra_status

## Overview

Expand Down Expand Up @@ -34,12 +34,24 @@ cd sierra_status
pip install
```

### Windows Executable

For Windows users, a standalone executable is available. You can download it directly from the latest GitHub release:

1. Go to the [Releases page](https://github.com/elkanamol/sierra_status/releases) of the project.
2. Find the latest release and download the `sierra-status.exe` file.
3. Once downloaded, you can run the executable directly without any additional installation.

## Usage

After installation, you can use the `sierra-status` command-line tool:

sierra-status -p [OPTIONS]

For Windows users using the standalone executable:

sierra-status.exe -p [OPTIONS]

### Required Arguments

- `-p, --port`: Specify the USB port to use (e.g., 'COM1' for Windows or '/dev/ttyUSB2' for Linux)
Expand Down

0 comments on commit 917955a

Please sign in to comment.