heavyrain.lee 6 years ago
parent
commit
f5cc9f6ceb
2 changed files with 40 additions and 2 deletions
  1. 15 0
      LICENSE
  2. 25 2
      README.md

+ 15 - 0
LICENSE

@@ -19,3 +19,18 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+1. ikidou/TypeBuilder
+Copyright 2016 ikidou
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

+ 25 - 2
README.md

@@ -1,2 +1,25 @@
-# robot_server
-Demo of wildfire chat robot
+# 野火IM机器人应用
+作为野火IM机器人应用的演示,本工程仅演示机器人应用的接口。其中用到图灵的免费版。
+
+#### 编译
+```
+mvn package
+```
+
+#### 图灵
+本应用使用了[图灵机器人](http://www.tuling123.com),需要申请到```atuling_key```,并配置到```robot.properties```中去。用户也可以自行更换为自己的机器人应用。如果不想使用图灵机器人,可以在配置里把参数```use_tuling```设置为false.
+
+#### 修改配置
+本演示服务有2个配置文件在工程的```config```目录下,分别是```application.properties```和```robot.properties```。请正确配置放到jar包所在的目录下的```config```目录下。
+
+#### 运行
+在```target```目录找到```robot-XXXX.jar```,把jar包和放置配置文件的```config```目录放到一起,然后执行下面命令:
+```
+java -jar robot-XXXXX.jar
+```
+
+#### 使用到的开源代码
+1. [TypeBuilder](https://github.com/ikidou/TypeBuilder) 一个用于生成泛型的简易Builder
+
+#### LICENSE
+UNDER MIT LICENSE. 详情见LICENSE文件