CompileDaemon 使用与技术文档

1. 安装指南

1.1 使用 go 工具安装

你可以使用 go 工具来安装 CompileDaemon：

go get github.com/githubnemo/CompileDaemon

确保你的 Go 版本为 1.16 或更高，并且设置了环境变量 GO111MODULE=on，这样你就可以在 $GOPATH/src 目录之外进行开发了。

2. 项目的使用说明

CompileDaemon 是一个简单的编译守护进程，用于监视目录中的 .go 文件，并在文件更改时调用 go build。使用方法如下：

$ ./CompileDaemon -directory=yourproject/

这将监视指定目录中的文件，并在文件更改时重新编译。

3. 项目API使用文档

3.1 命令行选项

以下是 CompileDaemon 支持的命令行选项：

选项	默认值	描述
-build=…	go build	指定在需要重新编译时运行的命令。
-command=…	none	指定在成功编译后运行的命令。默认不执行任何命令。
-directory=…	.	指定要监视的目录。
-recursive=…	true	是否递归监视指定目录。
-exclude-dir=…	none	排除与指定模式匹配的目录。可以有多个此选项。
-exclude=…	none	排除与指定模式匹配的文件。可以有多个此选项。
-include=…	none	包含与指定模式匹配的文件。可以有多个此选项。
-pattern=…	(.+\\.go|.+\\.c)$	匹配要监视的文件的正则表达式。默认监视 .go 和 .c 文件。
-polling=…	false	是否使用轮询方式检测文件变化。默认为 false。
-polling-interval=…	100	轮询方式下，文件变化检测的间隔时间（毫秒）。
-color=_	false	是否彩色化守护进程的输出信息。
-log-prefix=_	true	是否在子进程输出前添加 stdout/stderr 标签和日志时间戳。
-graceful-kill=_	false	在支持的平台中，是否发送 SIGTERM 信号以允许子进程优雅退出。

4. 项目安装方式

如前所述，你可以使用 go get 命令来安装 CompileDaemon。确保你的开发环境满足以下条件：

• Go 版本 1.16 或更高
• 设置环境变量 GO111MODULE=on

安装命令如下：

go get github.com/githubnemo/CompileDaemon

完成安装后，你可以通过以下命令启动 CompileDaemon：

./CompileDaemon -directory=yourproject/

以上就是 CompileDaemon 的安装和使用说明。希望这份文档能帮助你更好地了解和使用这个项目。