Compare commits

...

4 Commits

Author SHA1 Message Date
Gustavo Henrique Santos Souza de Miranda 03748cd8e7 Update README.md to change warning block to note block for flag usage clarification 2025-10-30 17:46:14 -03:00
Gustavo Henrique Santos Souza de Miranda 462d25a663 Fix formatting in README.md warning block 2025-10-30 17:35:50 -03:00
Gustavo Henrique Santos Souza de Miranda e1a239ef23 Update README.md to include a warning about flag usage 2025-10-30 17:33:58 -03:00
Gustavo Henrique Santos Souza de Miranda 441c2beda0 Add usage instructions and configuration details to README.md 2025-10-30 17:25:11 -03:00
1 changed files with 43 additions and 1 deletions

View File

@ -1 +1,43 @@
# 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.
>[!NOTE]
>
>The flags ``` -d ``` or the flag ```--detailed ``` can you be used with the flag ```--no-tui ```