build: standardize build and installation process in documentation and Makefile (#21)

- Add install, uninstall, and clean targets to the Makefile
- Change README instructions from `make build` to `make install`
- Update README.zh-cn instructions from `make build` to `make install`
- Update README.zh-tw instructions from `make build` to `make install`

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Reviewed-on: https://gitea.com/gitea/gitea-mcp/pulls/21
Co-authored-by: Bo-Yi Wu <appleboy.tw@gmail.com>
Co-committed-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu
2025-04-08 01:33:33 +00:00
committed by hiifong
parent 8dc9ed9299
commit 1fecc1df30
4 changed files with 25 additions and 5 deletions

View File

@@ -11,6 +11,26 @@ help: ## Print this help message.
@echo "" @echo ""
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
.PHONY: install
install: build ## Install the application.
@echo "Installing $(EXECUTABLE)..."
@mkdir -p $(GOPATH)/bin
@cp $(EXECUTABLE) $(GOPATH)/bin/$(EXECUTABLE)
@echo "Installed $(EXECUTABLE) to $(GOPATH)/bin/$(EXECUTABLE)"
@echo "Please add $(GOPATH)/bin to your PATH if it is not already there."
.PHONY: uninstall
uninstall: ## Uninstall the application.
@echo "Uninstalling $(EXECUTABLE)..."
@rm -f $(GOPATH)/bin/$(EXECUTABLE)
@echo "Uninstalled $(EXECUTABLE) from $(GOPATH)/bin/$(EXECUTABLE)"
.PHONY: clean
clean: ## Clean the build artifacts.
@echo "Cleaning up build artifacts..."
@rm -f $(EXECUTABLE)
@echo "Cleaned up $(EXECUTABLE)"
.PHONY: build .PHONY: build
build: ## Build the application. build: ## Build the application.
$(GO) build -v -ldflags '-s -w $(LDFLAGS)' -o $(EXECUTABLE) $(GO) build -v -ldflags '-s -w $(LDFLAGS)' -o $(EXECUTABLE)

View File

@@ -77,12 +77,12 @@ Before building, make sure you have the following installed:
Then run: Then run:
```bash ```bash
make build make install
``` ```
### 📁 Add to PATH ### 📁 Add to PATH
After building, copy the binary gitea-mcp to a directory included in your system's PATH. For example: After installing, copy the binary gitea-mcp to a directory included in your system's PATH. For example:
```bash ```bash
cp gitea-mcp /usr/local/bin/ cp gitea-mcp /usr/local/bin/

View File

@@ -77,7 +77,7 @@ git clone https://gitea.com/gitea/gitea-mcp.git
然后运行: 然后运行:
```bash ```bash
make build make install
``` ```
### 📁 添加到 PATH ### 📁 添加到 PATH

View File

@@ -77,12 +77,12 @@ git clone https://gitea.com/gitea/gitea-mcp.git
然後運行: 然後運行:
```bash ```bash
make build make install
``` ```
### 📁 添加到 PATH ### 📁 添加到 PATH
構建後,將二進制文件 gitea-mcp 複製到系統 PATH 中包含的目錄。例如: 安裝後,將二進制文件 gitea-mcp 複製到系統 PATH 中包含的目錄。例如:
```bash ```bash
cp gitea-mcp /usr/local/bin/ cp gitea-mcp /usr/local/bin/