refactor

Author: tiltwind

.github/workflows/build.yml

@@ -0,0 +1,35 @@
+name: Build
+
+on:
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+
+      - name: Install golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: latest
+          args: --timeout=5m
+
+      - name: Format
+        run: |
+          go fix ./...
+          go fmt ./...
+
+      - name: Test
+        run: go test ./... -v
+
+      - name: Build
+        run: go build -o namer .

.github/workflows/release.yml

@@ -0,0 +1,80 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Release version (e.g. v1.0.0)'
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - goos: linux
+            goarch: amd64
+            suffix: ''
+          - goos: linux
+            goarch: arm64
+            suffix: ''
+          - goos: darwin
+            goarch: amd64
+            suffix: ''
+          - goos: darwin
+            goarch: arm64
+            suffix: ''
+          - goos: windows
+            goarch: amd64
+            suffix: '.exe'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+
+      - name: Build
+        env:
+          GOOS: ${{ matrix.goos }}
+          GOARCH: ${{ matrix.goarch }}
+        run: |
+          output="namer-${{ github.event.inputs.version }}-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.suffix }}"
+          go build -ldflags="-s -w" -o "$output" .
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: namer-${{ matrix.goos }}-${{ matrix.goarch }}
+          path: namer-${{ github.event.inputs.version }}-*
+
+  publish:
+    needs: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Create tag
+        run: |
+          git tag ${{ github.event.inputs.version }}
+          git push origin ${{ github.event.inputs.version }}
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.event.inputs.version }}
+          name: ${{ github.event.inputs.version }}
+          files: dist/*
+          generate_release_notes: true

Makefile

@@ -0,0 +1,13 @@
+.PHONY: build
+
+lint:
+	golangci-lint run
+
+format:
+	go fix ./...
+	go fmt ./...
+
+test:
+	go test ./... -v
+
+build: format lint test

README.md

@@ -1,54 +1,113 @@
-# Namer 是中文取名工具，其根据你喜欢的字，自动组合出符合阴阳五行的名字。
+# Namer
 
-> 也许你不相信阴阳五行,但工具产生出诸多好名字，会为你带来灵感，让你取一个满意的名字。
+中文取名工具，根据你喜欢的字，自动组合出符合阴阳五行的名字。
 
-## 如何使用
+> 也许你不相信阴阳五行，但工具产生出诸多好名字，会为你带来灵感，让你取一个满意的名字。
+
+## 安装
+
+从 [Releases](https://github.com/vogo/namer/releases) 页面下载对应平台的二进制文件（支持 macOS、Linux、Windows）。
+
+或通过源码编译：
+
+```bash
+go install github.com/vogo/namer@latest
+```
+
+## 使用方法
+
+### 交互式批量评分
+
+```bash
+namer
+```
+
+首次运行时会交互式引导创建配置文件（`~/.namer.conf`），配置项包括姓氏、出生年月日时分、性别、名字备选字。
+
+### 单个名字评分
+
+```bash
+namer <姓> <名>               # 使用已有配置中的生辰信息
+namer <姓> <名> <生日>         # 指定生日，格式: 2024-03-15
+```
+
+示例：
+
+```bash
+namer 王 明轩
+namer 王 明轩 2024-03-15
+```
+
+### 指定配置文件
 
-1. 首先, 下载工具:
 ```bash
-go get github.com/wongoo/namer
+namer -c <配置文件>
 ```
 
-2. 其次, 准备配置文件config.json:
+### Web 界面
+
+```bash
+namer -web                    # 随机端口，自动打开浏览器
+namer -web -port 8080         # 指定端口
+```
+
+### 其他
+
+```bash
+namer -h                      # 显示帮助
+namer -v                      # 显示版本
+```
+
+## 配置文件
+
+默认路径：`~/.namer.conf`，首次运行会交互式引导创建。
+
+也可以手动创建 JSON 配置文件：
+
 ```json
 {
   "last_name": "王",
-  "year": 2018,
-  "month": 8,
+  "year": 2024,
+  "month": 3,
   "day": 15,
   "hour": 11,
   "minute": 1,
-  "gender": 0,  
-  "min_candidate_score":82,
-  "first_name_key_words": "可,计,学,习,书,意,义,复,开,程,进,望"
+  "gender": 0,
+  "min_candidate_score": 82,
+  "first_name_key_words": "可,学,书,意,义,程,进,望"
 }
 ```
-说明: 
-- `last_name`: 姓
-- `year`: 年
-- `month`: 月
-- `day`: 日
-- `hour`: 时
-- `minute`: 分
-- `gender`: 0-男, 1-女
-- `min_candidate_score`: 最小候选分数
-- `first_name_key_words`: 关键字
-
-3. 最后, 执行命令 `namer -c config.json`, 命令会输出分数排名前10的名字列表:
-```bash
+
+| 字段 | 说明 |
+|------|------|
+| `last_name` | 姓 |
+| `year` / `month` / `day` / `hour` / `minute` | 出生年月日时分 |
+| `gender` | 0-男, 1-女 |
+| `min_candidate_score` | 最小候选分数 |
+| `first_name_key_words` | 名字备选字（逗号分隔） |
+
+## 评分维度
+
+总分 100 分：
+
+| 维度 | 分值 | 说明 |
+|------|------|------|
+| 五格数理 | 30分 | 天格、人格、地格、总格、外格的数理吉凶 |
+| 三才配置 | 25分 | 天人地三才的五行生克关系 |
+| 喜用神 | 20分 | 名字五行是否补益八字喜用神 |
+| 内部五行 | 15分 | 姓名各字之间的五行生克 |
+| 阴阳平衡 | 10分 | 姓名各字笔画的阴阳搭配 |
+
+## 输出示例
+
+```
 score: 93, names: [王程]
 score: 92, names: [王计程]
 score: 89, names: [王望进 王开]
 score: 88, names: [王望程 王望开 王习程 王程意 王程义 王程进 王计开]
-score: 87, names: [王程开 王程程 王开程 王计学]
-score: 86, names: [王程习 王程望 王开望]
-score: 85, names: [王望学 王望意 王望复 王望义 王习进 王开进]
-score: 84, names: [王习开 王程复 王程学 王开意 王开义 王开开 王书进]
-score: 83, names: [王义程 王意程]
-score: 82, names: [王习意 王习义 王习复 王开习 王书望]
 ```
 
 ## 注意
-- 配置可以修改以后再次执行;
-- 可以`ctrl+c`中断执行,立即给出已经检测的结果;
-- 命令会在配置文件同目录下生成后缀为`.data`的缓存文件，请勿删除;
+
+- 配置可以修改后再次执行
+- 可以 `Ctrl+C` 中断执行，立即给出已检测的结果