Skip to content

Commit

Permalink
Add descriptions for the command-line arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
jessebraham committed Oct 31, 2024
1 parent 4af76e3 commit c8bba0d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -163,17 +163,23 @@ static CHIP_VARS: &[(Chip, &[(&str, &str)])] = &[
#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
struct Args {
/// Name of the project to generate
name: String,

/// Chip to target
#[arg(short, long)]
chip: Chip,

/// Run in headless mode (i.e. do not use the TUI)
#[arg(long)]
headless: bool,

// TODO: Can we list the options and/or point users to some documentation?
/// Generation options
#[arg(short, long)]
option: Vec<String>,

/// Directory in which to generate the project
#[arg(short = 'O', long)]
output_path: Option<PathBuf>,
}
Expand Down

0 comments on commit c8bba0d

Please sign in to comment.