GHMiranda
/
MetarNavigate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add usage instructions and configuration details to README.md

This commit is contained in:
Gustavo Henrique Santos Souza de Miranda 2025-10-30 17:25:11 -03:00
parent d8e9efd73a
commit 441c2beda0
1 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1 +1,41 @@
# METAR NAVIGATE # METAR NAVIGATE
A Simple METAR Application that feeds from CheckWX API
It has two modes of display, a simple CLI using Rich and a TUI using Textual
## Usage
First, you need to install the application by issuing:
```bash
pip install -e .
```
this will install the application and the dependencies
after that you'll need to configure the application by issuing:
```bash
metarNavigate --no-tui -c
```
or
```bash
metarNavigate --no-tui --configure
```
you'll need a checkWX API key to use the application which is free
after the configuration process you can use the application by issuing:
```bash
metarNavigate --no-tui <ICAO>
```
this will run the application in CLI mode and display the METAR for the ICAO code issued as argument.
If you wish to see a detailed breakdown of the METAR in CLI mode, you can issue:
```bash
metarNavigate --no-tui --detailed <ICAO>
```
or
```bash
metarNavigate --no-tui -d <ICAO>
```
this will print all details of the METAR Message with an explanation of each part of the message.