Skip to content

Commit

Permalink
update document
Browse files Browse the repository at this point in the history
  • Loading branch information
kcmvp committed Jan 23, 2024
1 parent c91dd4e commit 19b79b3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ these tools and frameworks exist independently to solve specific problems.
Whenever a new Golang project is started, it requires a series of initialization;
What’s worse is that whenever your switch the development environment, same process have to be repeated!
This project is built to solve this problem by providing a method similar to [Maven](https://maven.apache.org/)
or [Gradle](https://gradle.com/) in the **Java** ecosystem. Please refer [document](./docs/document.md) for details
or [Gradle](https://gradle.com/) in the **Java** ecosystem. Please refer [Document](#document-) for details

<span id="nav-3"></span>

Expand All @@ -55,6 +55,11 @@ This command will generate two files
>- .golangci.yaml: [golangci-lint](https://golangci-lint.run/) configuration. gob supports `golangci-lint` butilin
> These two files need to be checked in with your source code
| Git Hooks | Dependency Tree |
|-----------|-----------------|
|<img src="https://github.com/kcmvp/gob/blob/main/docs/commit_hook.gif" height="245" width="425"> |<img src="https://github.com/kcmvp/gob/blob/main/docs/dependency_tree.png" height="245" width="425"> |


3. Make some changes in your source code and try to commit the code, you will see below screenshot.
> <img src="https://github.com/kcmvp/gob/blob/main/docs/commit_hook.gif" height="245" width="425">
Expand All @@ -66,6 +71,7 @@ gob deps
> <img src="https://github.com/kcmvp/gob/blob/main/docs/dependency_tree.png" height="245" width="425">

## Document


## FAQ
Expand Down

0 comments on commit 19b79b3

Please sign in to comment.