Skip to content

Commit

Permalink
Update docs/info in CLI, Cargo.toml, and README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
liamhays committed Nov 23, 2023
1 parent c55c027 commit 37afe9b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
name = "flipwire"
version = "0.1.0"
edition = "2021"
readme = "README.md"
repository = "https://github.com/liamhays/flipwire"
license = "MIT"
description = "Bluetooth app to control a Flipper Zero from a PC"

[dependencies]
btleplug = "0.11.1"
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Commands:
- `launch <app>`: launch a `.fap` file on the Flipper.
- `ls <dir>`: list a directory on the Flipper.
- `alert`: play an alert on the Flipper to help you find it.
- `synctime`: sync the Flipper's clock to the computer's clock.

## Flipper paths
The Flipper uses a Unix-style path system to specify paths in internal
Expand All @@ -62,8 +63,14 @@ Because I like Rust. Also, because the Flipper ecosystem has a strong
"plug and play" mentality, and Rust makes it easy to make an
application that does exactly that.

## Where's the GUI?
No GUI yet, possibly never. A GUI makes the application a lot larger
and more complex, and on top of that, there isn't much Rust GUI
support right now. If I do add GUI support, I would probably use
[imgui-rs](https://github.com/imgui-rs/imgui-rs).

## Flipwire hangs during a download.
Run through the troubleshooting steps below just in case some has
Run through the troubleshooting steps below just in case something has
temporarily broken. If the issue still happens, then your Bluetooth
adapter is probably incompatible with the Flipper. Report your adapter
model in a new issue and I'll add it to the list above.
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ struct Cli {
#[command(subcommand)]
command: Commands,

/// Unique Flipper name (e.g., "Uwu2" for "Flipper Uwu2")
/// Unique Flipper name, like "Uwu2" for "Flipper Uwu2" (required!)
#[arg(short)]
flipper_name: String,

Expand Down

0 comments on commit 37afe9b

Please sign in to comment.