From aba651ed21d257e1df020d3bee1563c24c5c7741 Mon Sep 17 00:00:00 2001
From: fengxxc <fengxxc@gmail.com>
Date: Fri, 3 Dec 2021 12:01:51 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20update=20README=20=E5=92=8C=E6=B3=A8?=
 =?UTF-8?q?=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Makefile  |  2 +-
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 9beb95b..b540d02 100644
--- a/Makefile
+++ b/Makefile
@@ -13,7 +13,7 @@ build-win32: clean
 	${BUILD_ENV} GOOS=windows GOARCH=386 go build -ldflags "-s -w" -o build/${APP}_win32.exe main.go
 
 
-# windows环境编译 需安装mingw32-make 
+# windows环境编译 需gcc，推荐安装tdm64-gcc
 # mingw32-make [cmd]
 win-build-linux: clean
 	go env -w ${BUILD_ENV}
diff --git a/README.md b/README.md
index d6acf70..872900e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,42 @@
 # wechatmp2markdown 微信公众号文章转Markdown
+
+## 使用
+执行命令：`本程序可执行文件 [url] [filename]`
+- `url` 微信公众号文章网页的url
+- `filename` makedown文件的保存路径和文件名
+
+例如：windows环境，想把url为`https://mp.weixin.qq.com/s/abcdefg`的文章转成markdown存到 `D:\wechatmp_bak\abc.md` 
+
+则执行： `wechatmp2makrdown_win64.exe https://mp.weixin.qq.com/s/abcdefg D:\wechatmp_bak\abc.md`
+
+## 开发
+### 编译
+#### Linux or Mac 环境
+```
+# 编译目标平台: linux
+make build-linux
+# 编译目标平台: mac
+make build-osx
+# 编译目标平台: windows 64位
+make build-win64
+# 编译目标平台: windows 32位
+make build-win32
+```
+#### windows 环境
+需gcc，推荐安装tdm64-gcc，`mingw64/bin`加入系统环境变量
+```
+# 编译目标平台: linux
+mingw32-make win-build-linux
+
+# 编译目标平台: mac
+mingw32-make win-build-osx
+
+# 编译目标平台: windows 64位
+mingw32-make win-build-win64
+
+# 编译目标平台: windows 32位
+mingw32-make win-build-win32
+```
+没装gcc也无妨，去Makefile找对应的命令执行
+
+编译好的文件在`./build`目录下
\ No newline at end of file