star7th 10 years ago
parent
commit
1d1a6edc7c
4 changed files with 51 additions and 7 deletions
  1. 0 0
      Application/Common/Conf/config.php.sample
  2. 31 0
      LICENSE.txt
  3. 19 6
      README.md
  4. 1 1
      showdoc.sql

+ 0 - 0
Application/Common/Conf/config.php → Application/Common/Conf/config.php.sample


+ 31 - 0
LICENSE.txt

@@ -0,0 +1,31 @@
+
+ShowDoc遵循Apache2开源协议发布,并提供免费使用。
+版权所有Copyright © 2015 by star7th (http://blog.star7th.com/)
+All rights reserved。
+
+Apache Licence是著名的非盈利开源组织Apache采用的协议。
+该协议和BSD类似,鼓励代码共享和尊重原作者的著作权,
+允许代码修改,再作为开源或商业软件发布。需要满足
+的条件: 
+1. 需要给代码的用户一份Apache Licence ;
+2. 如果你修改了代码,需要在被修改的文件中说明;
+3. 在延伸的代码中(修改和有源代码衍生的代码中)需要
+带有原来代码中的协议,商标,专利声明和其他原来作者规
+定需要包含的说明;
+4. 如果再发布的产品中包含一个Notice文件,则在Notice文
+件中需要带有本协议内容。你可以在Notice中增加自己的
+许可,但不可以表现为对Apache Licence构成更改。 
+具体的协议参考:http://www.apache.org/licenses/LICENSE-2.0
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

+ 19 - 6
README.md

@@ -10,21 +10,19 @@ ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以
 
 ###它可以用来做什么
 
-- #### API文档
+- #### API文档(<a href="http://doc.star7th.com/2" target="_blank">查看Demo</a>)
 
 	随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
-	API文档DEMO地址:<a href="http://doc.star7th.com/2" target="_blank">链接</a>
 
-- #### 数据字典
+- #### 数据字典(<a href="http://doc.star7th.com/1" target="_blank">查看Demo</a>)
 
 	一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
-	数据字典DEMO地址:<a href="http://doc.star7th.com/1" target="_blank">链接</a>
 
 - #### 说明文档
 
 	你完全可以使用showdoc来编写一些工具的说明书。例如你正在看的教程说明便是用showdoc编辑的。你也可以编写一些技术规范说明文档以供团队查阅
 
-###它都有些什么功能
+###它都有些什么功能
 
 	
 - ####分享与导出
@@ -54,4 +52,19 @@ ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以
 	
 	- 历史版本
 	
-		ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
+		ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
+
+###如何部署代码
+	- 克隆或者下载代码:
+		<a href="https://github.com/star7th/showdoc" target="_blank">https://github.com/star7th/showdoc</a>
+	- 导出数据库
+		下载代码后,将跟目录的showdoc.sql文件导入mysql数据库
+	- 修改配置文件
+		Application/Common/Conf/目录下的config.php.sample文件重命名为config.php。编辑config.php文件,填写相应的数据库信息
+	- 目录权限
+		请确保Application/Runtime 有可写权限
+
+###版权
+	ShowDoc遵循Apache2开源协议发布,并提供免费使用。
+	版权所有Copyright © 2015 by star7th ( http://blog.star7th.com/ )
+	All rights reserved

File diff suppressed because it is too large
+ 1 - 1
showdoc.sql


Some files were not shown because too many files changed in this diff