diff --git a/README.md b/README.md index a8677d01..70e41b12 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ public class MainLauncher { 期待您的加入 - [ ] 基础框架 - - [ ] 基础框架的文档 + - [x] 基础框架的文档 - [x] 基本框架的实现 - [ ] 服务器类启动器 - [ ] web类启动器 @@ -104,11 +104,18 @@ public class MainLauncher { - [x] wkcache 方法缓存 - [ ] docker相关 - [ ] docker compose配置 - +- [ ] WebService + - [ ] CXF ## 第三方starter或项目 期待您的到来,报个issue告知一下吧 ^_^ +## 文档 + +* [NutzBoot简介](doc/overview.md) +* [NutzBoot目录约定](doc/struct.md) +* [NB与Nutz.Mvc对比](doc/diff_nb_mvc.md) + ## 授权协议 与Nutz一样, NutzBoot遵循[Apache协议](LICENSE),完全开源,文档齐全,永远免费(商用也是) \ No newline at end of file diff --git a/doc/diff_nb_mvc.md b/doc/diff_nb_mvc.md new file mode 100644 index 00000000..117d831a --- /dev/null +++ b/doc/diff_nb_mvc.md @@ -0,0 +1,21 @@ +# NutzBoot与NutzMvc的关系 + +用表格来说说吧 + +| 功能点 |NutzBoot|Nutz.MVC| +|---------|---------|-------| +|运行环境 | 独立运行 |Web容器(Jetty/Tomcat等)| +|打包方式 | Jar | war | +|灵活性 | 一般 | 高 | +|支持分布式| 容易 | 一般 | +|自动reload|尚无 |依赖容器| +|动静分离 | 方便 | 不太友好| +|配置文件 | 有 | 有 | +|命令行参数|有 |没有 | +|环境参数 |有 |有 | +|主入口 |MainLauncher|MainModule| + +* MainLauncher能使用MainModule的大部分注解,若已加入Nutz.MVC的starter,除了@LoadingBy注解 +* 在NutzBoot中,Nutz.MVC会作为一个starter存在,99%以上的功能都能如常使用 +* NutzBoot灵活性低一些是因为规范了最佳实践,降低了随意性 +* 自动reload指类文件的reload,页面文件不受影响 \ No newline at end of file diff --git a/doc/overview.md b/doc/overview.md index d2f4d90d..471f509d 100644 --- a/doc/overview.md +++ b/doc/overview.md @@ -1,4 +1,4 @@ -#NutzBoot简介 +# NutzBoot简介 ## 什么是Nutz Boot?