Browse Source

readme 修改

SisMaker 4 years ago
parent
commit
17e6831ebe
2 changed files with 7 additions and 4 deletions
  1. +4
    -3
      README.md
  2. +3
    -1
      erlSync.sample.config

+ 4
- 3
README.md View File

@ -1,8 +1,9 @@
# erlSync
otp21.2+
#基于 [fsnotify](https://github.com/fsnotify/fsnotify) 跨平台文件系统通知。
#改造自 [sync](https://github.com/rustyio/sync)
#封装的监听文件项目[fileSync](https://github.com/SisMaker/fileSync) .如果要自己构建执行文件, 拉取监听文件项目, 然后 go build 复制执行文件到该工程的 priv 目录即可
Erlang即时重新编译和重新加载!
## 基于 [fsnotify](https://github.com/fsnotify/fsnotify) 跨平台文件系统通知。
## 改造自 [sync](https://github.com/rustyio/sync)
## 封装的监听文件项目[fileSync](https://github.com/SisMaker/fileSync) 如果要自己构建执行文件, 拉取监听文件项目, 然后 go build 复制执行文件到该工程的 priv 目录即可
# 特点
本项目实现了自带编译与加载功能,另外支持额外的编译命令,但是执行额外的编译命令是通过os:cmd(),会阻塞VM不是很建议使用.

+ 3
- 1
erlSync.sample.config View File

@ -15,7 +15,9 @@
%% 这个参数用于设置特殊目录下的文件检查编译与加载
%% 格式:{extraDirs, [{strategy(), [srcDirDescr()]}} | {srcDirs, undefined]}
%% -type strategy() :: add | only | del.
%% 如果 strategy() is only, 仅仅扫描指定目录下的文件编译与加载. 如果 strategy() is add, 会扫描添加的指定目录同步编译与加载.
%% 如果 strategy() when add, 会无条件监听添加的指定目录及其子目录同步编译与加载.
%% 如果 strategy() when only, 仅仅监听指定目录及其子目录下的文件编译与加载.
%% 如果 strategy() when del, 则不会监听该目录及其子目录下的文件.
%% -type srcDirDescr() :: { Dir :: file:filename(), [Options :: compile_option()]}.
%% 默认值:undefined 根据当前工作目录 和 已经加载的模块做来得出需要扫描的目录
%%示例: {extraDirs, [{add, [{"./_build/default/lib/erlGbh", []}]}, {only, [{"./", []}]}, {del, [{"./_build", []}]}]}.

Loading…
Cancel
Save