From 14f38b792dc3243bb9914ad7ec3d867ee5b50d0d Mon Sep 17 00:00:00 2001 From: Ardeman Date: Thu, 27 Feb 2025 10:20:55 +0800 Subject: [PATCH] chore: add markdownlint configuration and update README for installation instructions --- .markdownlint.json | 8 ++++++++ README.md | 19 +++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..f817d8f --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "default": true, + "MD013": false, + "MD026": false, + "MD033": false, + "MD040": false, + "MD041": false +} diff --git a/README.md b/README.md index 2d40cfe..0ebab3b 100644 --- a/README.md +++ b/README.md @@ -10,31 +10,40 @@ Before proceeding, make sure you have the following installed on your computer: ## Steps to Install Go 1.24.0 ### For Windows: + 1. Download the installer from [official Go website](https://golang.org/dl/). 2. Run the downloaded `.msi` file and follow the installation wizard. 3. During installation, you may be prompted to set the `GOPATH` and `GOROOT`. Choose the appropriate settings based on your preference or keep the default values. ### For macOS: + 1. Open Terminal. 2. Download the package using Homebrew (if not installed, visit [Homebrew website](https://brew.sh/) for installation instructions): + ```bash brew install go@1.24 ``` + 3. Link the installed version to your PATH: + ```bash brew link --overwrite --force go@1.24 ``` ### For Linux: + 1. Open Terminal. 2. Download the appropriate tarball from [official Go website](https://golang.org/dl/). 3. Extract the downloaded archive: + ```bash tar -C /usr/local -xzf go1.24.linux-amd64.tar.gz ``` + 4. Add Go to your PATH by editing your shell configuration file (e.g., `.bashrc`, `.zshrc`): + ```bash echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc source ~/.bashrc @@ -43,18 +52,22 @@ installation instructions): ## Verify Installation After installation, verify that Go 1.24.0 is installed correctly by running: + ```bash go version ``` + You should see an output like `go version go1.24 darwin/amd64` (or similar, depending on your OS). ## Install Make (if not already installed) ### For Windows: + - Download and install [Make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm). - Add the installation directory to your PATH. ### For macOS: + 1. Open Terminal. 2. Install Make using Homebrew: ```bash @@ -62,6 +75,7 @@ You should see an output like `go version go1.24 darwin/amd64` (or similar, depe ``` ### For Linux: + Make is usually pre-installed on most Linux distributions. If it's not installed, you can install it using your package manager (e.g., `sudo apt-get install make` for Ubuntu). @@ -72,6 +86,7 @@ Open Terminal and navigate to the root directory of your Go project. ## Resolve Dependencies with `go mod tidy` Run the following command to download and resolve all dependencies specified in your `go.mod` file: + ```bash go mod tidy ``` @@ -79,6 +94,7 @@ go mod tidy ## Setup Database In your Go application, you'll need to set the following environment variables to connect to your database: + ```bash DB_HOST: The hostname or IP address of your database server (e.g., localhost, 127.0.0.1, or the actual DB server URL). DB_USER: The username for your database connection. @@ -103,6 +119,7 @@ Make sure to replace the values with your actual database details. ## Build the Binary Using `make build` Run the following command to build your project. The binary will be placed in the `bin` folder. + ```bash make build ``` @@ -110,6 +127,7 @@ make build ## Run the Program Using `make run` Finally, you can run your program using: + ```bash make run ``` @@ -120,6 +138,7 @@ This command will compile and execute your Go application. **Note:** Ensure that your `Makefile` is correctly set up to handle these commands. If not, you may need to create or adjust it accordingly. + ``` Please follow the above instructions to set up Go version 1.24.0, manage dependencies using `go mod tidy`, build a