Merge pull request #156 from Ri-Nai/docs/readme

docs: 更新 README，添加本地开发和启动项目的说明

.vitepress/navSidebar.mjs

@@ -2,7 +2,7 @@ import fs from 'node:fs'
 import path from 'node:path'
 
 const DOC_EXT = ['.md']
-const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public'])
+const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public', 'docs'])
 
 function isDirectory(p) {
   return fs.existsSync(p) && fs.statSync(p).isDirectory()

.vitepress/scripts/generate-indexes.mjs

@@ -2,7 +2,7 @@ import fs from 'node:fs'
 import path from 'node:path'
 
 const ROOT = process.cwd()
-const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public'])
+const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public', 'docs'])
 
 function isDirectory(p) {
   return fs.existsSync(p) && fs.statSync(p).isDirectory()

README.md

@@ -1,12 +1,18 @@
 ![pic](/banner.png)
 
+<div align="center">
+
+[**Docker Support**](./docker_support/README.md) | [**Development**](./docs/development.md)
+
+</div>
+
 # 像老乡鸡那样做饭
 
 [**一些说明**](https://github.com/Gar-b-age/CookLikeHOC/issues/26)
 
 仓库主体部分于2024年完工，和2025年9月份的舆论事件无关。截止提交时，仓库的贡献者们与老乡鸡的唯一关系只有消费者和商家的关系。本仓库不是老乡鸡的官方仓库。如果有任何问题或意见建议，欢迎指出
 
-**新更新**
+## 新更新
 
 - 欢迎大家来贡献实拍图
 
@@ -28,14 +34,14 @@
 
 至于为什么仓库名要叫CookLikeHOC，因为直接写Laoxiangji大概不方便阅读，而Home Original Chicken是china daily报道中所使用的老乡鸡的英文名，故简写成HOC。
 
-Contributor
+
+## Contributor
 
 ![cr](https://contrib.rocks/image?repo=Gar-b-age/CookLikeHOC)
 
-Logo
+## Logo
 ![pic](/logo.png) 
 
-Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=Gar-b-age/CookLikeHOC&type=Date)](https://star-history.com/#Gar-b-age/CookLikeHOC&Date)
+## Star History
 
+[![Star History Chart](https://api.star-history.com/svg?repos=Gar-b-age/CookLikeHOC&type=Date)](https://star-history.com/#Gar-b-age/CookLikeHOC&Date)

docs/development.md

@@ -0,0 +1,63 @@
+# 本地开发
+
+### 前置依赖
+
+在开始之前，请确保你的开发环境中安装了 [Node.js](https://nodejs.org/) (推荐 v18.x 或更高版本)。
+
+- **Windows:**
+
+  可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。
+  或者使用包管理器 [Chocolatey](https://chocolatey.org/):
+  ```bash
+  choco install nodejs
+  ```
+
+- **macOS:**
+
+  可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。
+  或者使用包管理器 [Homebrew](https://brew.sh/):
+  ```bash
+  brew install node
+  ```
+
+- **Linux:**
+
+  对于 Debian/Ubuntu 系统，可以使用 [NodeSource](https://github.com/nodesource/distributions) 来安装:
+  ```bash
+  curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
+  sudo apt-get install -y nodejs
+  ```
+
+  对于 RHEL/CentOS 系统:
+  ```bash
+  curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash -
+  sudo yum install -y nodejs
+  ```
+
+### 启动项目
+
+1. 克隆代码仓库
+
+   ```bash
+   git clone https://github.com/Gar-b-age/CookLikeHOC.git
+   ```
+
+2. 进入项目目录
+
+   ```bash
+   cd CookLikeHOC
+   ```
+
+3. 安装依赖
+
+   ```bash
+   npm install
+   ```
+
+4. 运行
+
+   ```bash
+   npm run docs:dev
+   ```
+
+   然后打开浏览器，访问 http://localhost:5173/ 即可。