Skip to content

Commit

Permalink
docs(readme): perfect document.
Browse files Browse the repository at this point in the history
  • Loading branch information
sdttttt committed Sep 25, 2020
1 parent df01f7a commit f82e761
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,36 @@ Standardized Git submission tool. “Grc” is a temporary name.

Similar to git-cz, gcr will help you to provide a better Git experience.

## Using
## Install

You can install **grc** in the following ways:

### From Cargo

Please Run `cargo install grc`.

### Release Package

after the tools install, run command:
Go to [RELEASE](https://github.com/sdttttt/gcr/releases), download one you like.

### From Source

Please Run:

```bash
grc
git clone --depth=1 https://github.com/sdttttt/gcr.git

cd gcr

cargo build --release
```

grc under `target/release/`.

## Using

after the tools install, run command in your repository:

```
grc
```
1 change: 1 addition & 0 deletions src/arguments.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ enum Mode {
Commit,
}


pub struct Arguments {
mode: Mode
}
Expand Down

0 comments on commit f82e761

Please sign in to comment.