Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eugene-babichenko committed Jun 12, 2024
1 parent d9f8986 commit 05155f4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 16 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version = "0.1.0"
edition = "2021"
license = "MIT"
authors = [ "Yevhenii Babichenko <[email protected]>" ]
homepage = "https://github.com/eugene-babichenko/fixit"

[dependencies]
clap = { version = "4", features = ["derive", "env"] }
Expand Down
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,11 @@ command:

## Shell setup

### bash
Add the corresponding line to your shell configuration file

Add this to your `.bashrc`

eval "$(fixit init bash)"

### zsh

Add this to your `.zshrc`

eval "$(fixit init zsh)"

### fish

Add this line to your `config.fish` (usually `~/.config/fish/config.fish`):

fixit init fish | source
- bash: `eval "$(fixit init bash)"`
- zsh: `eval "$(fixit init zsh)"`
- fish: `fixit init fish | source`

## Teminal emulator/multiplexer setup

Expand Down
4 changes: 4 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ mod fix;
mod init;
mod rules;

/// A command line utility that fixes mistakes in your previous command.
///
/// More info: https://github.com/eugene-babichenko/fixit
#[derive(Parser)]
#[command(version, about)]
struct Args {
#[command(subcommand)]
command: Commands,
Expand Down

0 comments on commit 05155f4

Please sign in to comment.