修改readme
This commit is contained in:
parent
0c6715aa88
commit
fee185bea8
36
README.en.md
36
README.en.md
@ -1,36 +0,0 @@
|
||||
# MrDoc
|
||||
|
||||
#### Description
|
||||
一个简单的文档系统
|
||||
|
||||
#### Software Architecture
|
||||
Software architecture description
|
||||
|
||||
#### Installation
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Instructions
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Contribution
|
||||
|
||||
1. Fork the repository
|
||||
2. Create Feat_xxx branch
|
||||
3. Commit your code
|
||||
4. Create Pull Request
|
||||
|
||||
|
||||
#### Gitee Feature
|
||||
|
||||
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
||||
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
||||
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
||||
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
||||
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
42
README.md
42
README.md
@ -1,41 +1,45 @@
|
||||
# MrDoc
|
||||
|
||||
#### 介绍
|
||||
一个简单的文档系统
|
||||
## 介绍
|
||||
一个简单的文档写作系统
|
||||
|
||||
#### 软件架构
|
||||
## 软件架构
|
||||
基于Python Web框架Django构建。
|
||||
|
||||
语言:Python 3
|
||||
|
||||
后端:Django 2.1
|
||||
前端:LayUI 2.5.4
|
||||
编辑器:Editormd
|
||||
|
||||
前端UI:LayUI 2.5.4
|
||||
|
||||
#### 安装教程
|
||||
文档编辑器:Editormd
|
||||
|
||||
社交分享:Share.js
|
||||
|
||||
科学公式:Katex
|
||||
|
||||
## 安装教程
|
||||
|
||||
1. 下载并解压;
|
||||
2. 如果需要使用其他数据库,请修改;
|
||||
3. 运行python manage.py makemigrations&&python manage.py migrate 创建和执行数据库迁移;
|
||||
4. 运行python manage.py createsuperuser 创建管理员账号;
|
||||
|
||||
#### 使用说明
|
||||
## 使用说明
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### 参与贡献
|
||||
## 二次开发说明
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
## 参与贡献
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 新建 Feat_xxx 分支
|
||||
3. 提交代码
|
||||
4. 新建 Pull Request
|
||||
|
||||
|
||||
#### 码云特技
|
||||
|
||||
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
|
||||
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
|
||||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
|
||||
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目
|
||||
5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
||||
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
4. 新建 Pull Request
|
||||
@ -74,7 +74,7 @@
|
||||
<div class="layui-card">
|
||||
<div class="layui-card-header"><i class="layui-icon layui-icon-add-1"></i> 创建文档</div>
|
||||
<div class="layui-card-body">
|
||||
新建一个文档,马上开始愉快的写作……
|
||||
新建一个文档,马上开始写作……
|
||||
</div>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user