From 6fa2f64527f5d0190b663cb124d41d6c62c6cb79 Mon Sep 17 00:00:00 2001 From: JustSong Date: Fri, 11 Nov 2022 15:10:32 +0800 Subject: [PATCH] docs: update readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 03e8ed7..9d9477f 100644 --- a/README.md +++ b/README.md @@ -27,14 +27,17 @@ ## Usage 1. Download built binaries from [GitHub Releases](https://github.com/songquanpeng/gin-template/releases/latest) or build from source: - 1. `git clone https://github.com/songquanpeng/gin-template.git` - 2. `go mod download` - 3. `go build -ldflags "-s -w" -o gin-template` + ```shell + git clone https://github.com/songquanpeng/gin-template.git + go mod download + go build -ldflags "-s -w" -o gin-template + ```` 2. Run it: - 1. `chmod u+x gin-template` - 2. `./gin-template --port 3000 --log-dir ./logs` + ```shell + chmod u+x gin-template + ./gin-template --port 3000 --log-dir ./logs + ``` 3. Command line arguments: - 4. The username for the initial account is `root` and the password is `123456`. ## Basic Configurations