Junling Bu 7 年 前
コミット
018a8598cd
3 ファイル変更26 行追加43 行削除
  1. 6 6
      CHANGELOG.md
  2. 5 5
      CONTRIBUTE.md
  3. 15 32
      README.md

+ 6 - 6
CHANGELOG.md

@@ -1,6 +1,6 @@
-## 更新日志
+# 更新日志
 
-### V 0.5.0
+## V 0.5.0
  
 *2018-05-11*,项目支持微信支付和修复小程序的一些BUG
  
@@ -18,7 +18,7 @@
   * `项目`文档整理部署方案和上线方案
   * `项目`文档支持更新日志、贡献指南和常见问题
 
-### V 0.4.0
+## V 0.4.0
  
 *2018-04-21*,项目结构调整,增加了两个模块
  
@@ -33,7 +33,7 @@
   * `基础系统`新增litemall-all模块作为包裹模块,支持三个后台服务和静态文件
      打包成一个war项目包
      
-### V 0.3.0 
+## V 0.3.0 
 
 *2018-04-07*,业务模块从物理删除调整成逻辑删除
 
@@ -46,7 +46,7 @@
 * `基础系统`数据库中除regions几个表,其他所有表都添加`add_time`和`deleted`字段
 * `基础系统`litemall-db模块不支持数据物理删除,删除则设置`deleted`,而查询则过滤`deleted`
 
-### V 0.2.0
+## V 0.2.0
 
 *2018-04-02*,修复一些小商场出现的问题。
 
@@ -59,6 +59,6 @@
 * `管理后台`禁止管理员修改超级管理员信息
 * `基础系统`自动脚本util/lazy.sh和util/upload.sh
   
-### V 0.1.0
+## V 0.1.0
 
 *2018-03-24*, 项目架构基本完成。

+ 5 - 5
CONTRIBUTE.md

@@ -1,4 +1,4 @@
-## 贡献
+# 贡献指南
 
 任何形式的贡献都欢迎,包括:
 
@@ -13,7 +13,7 @@
 目前项目基本框架已经建立,但是还不完整,因此非常欢迎人一起讨论技术和业务。
 但是交流合作之前,请查看以下碎碎念。
 
-### 项目理念
+## 项目理念
 
 litemall的设计受众是小微型企业,而不是互联网企业,因此litemall的开发理念是一个小而美:
 
@@ -68,7 +68,7 @@ litemall的设计受众是小微型企业,而不是互联网企业,因此lit
 当然,如果开发者不认同这里的一些理念,也可以基于自己的技术选型来开发自己的版本。
 如果认为自己开发的好,可以在本项目提交链接地址,让其他开发者了解。
 
-### 项目业务
+## 项目业务
 
 本项目所设想的基本业务功能已经在文档中列举完成。
 
@@ -78,11 +78,11 @@ litemall的设计受众是小微型企业,而不是互联网企业,因此lit
 
 当然更希望开发者直接提供代码,丰富完善目前的基础业务功能。
 
-### 代码贡献
+## 代码贡献
 
 * 代码规范目前没有严格要求,后续会补充。
 
-### Issue规范
+## Issue规范
 
 * 在提交issue之前,请搜索是否存在相关问题。
 * 提交的Issue请尽可能给出详细信息

+ 15 - 32
README.md

@@ -1,20 +1,16 @@
-litemall
-=====
+# litemall
 
 又一个小商场系统。
 
-项目代码
-====
+## 项目代码
 
 * [码云](https://gitee.com/linlinjava/litemall)
 * [GitHub](https://github.com/linlinjava/litemall)
 
-项目架构
-====
+## 项目架构
 ![](./doc/pic/1.png)    
 
-技术栈
-===
+## 技术栈
 
 > 1. Spring Boot
 > 2. Vue
@@ -22,8 +18,7 @@ litemall
 
 ![](doc/pic/2.png)    
 
-效果
-==
+## 效果
 
 ### 小商城效果
 
@@ -78,8 +73,7 @@ litemall
   * 管理员
   * 对象存储
 
-云演示
-==
+## 云演示
 
 ### 小商城演示访问
 
@@ -97,8 +91,7 @@ litemall
 1. 浏览器打开,输入以下网址[http://122.152.206.172:8080/#/login](http://122.152.206.172:8080/#/login)
 2. 管理员名称`admin123`,管理员密码`admin123`
 
-文档
-==
+## 文档
 
 1. [系统架构](doc/1.md)
 2. [基础平台](doc/2.md)
@@ -110,8 +103,7 @@ litemall
 
 文档内容采用 [署名-禁止演绎 4.0 国际协议许可](https://creativecommons.org/licenses/by-nd/4.0/deed.zh)
 
-开发计划
-====
+## 开发计划
 
 目前项目开发中,存在诸多不足,以下是目前规划的开发计划。
 
@@ -141,37 +133,30 @@ V 3.0.0 完成以下目标:
 警告:
 > ** 以上仅仅是个人规划的开发计划,实际可能出现任何情况,例如能力有限而放弃开发。**
 
-开发进度更新
-======
+## 开发进度
 
 查看[更新日志](CHANGELOG.md)
 
 目前V0.5.0
 
-警告
-==
+## 警告
 
 > 1. 本项目仅用于学习练习
 > 2. 数据库数据来自nideshop
 > 3. 项目代码目前还不完善,仍处在开发中
 > 4. 项目开源(MIT),但不承担任何使用后果
 
-致谢
-==
+## 致谢
 
 本项目基于或参考以下项目:
 > 1. [nideshop-mini-program](https://github.com/tumobi/nideshop-mini-program)
 > 如果后端希望采用nodejs,开发者可以访问nideshop项目
-> 2. [platform](https://gitee.com/fuyang_lipengjun/platform)
-> 如果后端希望采用非spring boot版的普通spring版或者更多功能,
-> 开发者可以访问platform项目
-> 3. [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)
+> 2. [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)
 > 一个基于Vue和Element的后台集成方案
 
 本项目所依赖的其他开源项目见相关章节
 
-问题
-==
+## 问题
 
 开发者有问题或者好的建议可以用Issues反馈交流,请给出详细信息,本人会尽可能解决。
  * 如果问题是共性问题(如代码bug或文档不全),本人会及时解决。
@@ -183,8 +168,7 @@ V 3.0.0 完成以下目标:
     * 请查看相关技术的官方文档,例如微信小程序的官方文档;
     * 请提问前尽可能做一些DEBUG或者思考分析,然后提问时给出详细的错误相关信息以及个人对问题的理解。
      
-贡献
-==
+## 贡献
 
 任何形式的贡献都欢迎,查看[贡献指南](CONTRIBUTE.md)
 
@@ -195,7 +179,6 @@ V 3.0.0 完成以下目标:
 > * 在开发交流群中应讨论开发、业务和合作问题。
 > * 交流结果如果是共识性的则在文档中记录,如果是开放性的则会在Issue中记录。
 
-相关项目
-====
+## 相关项目
 
 [HubertYoung](https://github.com/HubertYoung)正在开发Android端[Litemall-Android](https://github.com/HubertYoung/Litemall-Android)