From c6b87d30a532c61cb0e50aa2a511246517adf852 Mon Sep 17 00:00:00 2001 From: jerryjzhang Date: Tue, 12 Sep 2023 17:09:23 +0800 Subject: [PATCH] [improvement][docs]Move "how to build" chapter to project wiki --- README.md | 18 +++--------------- README_CN.md | 18 +++--------------- 2 files changed, 6 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d9792ccd1..d58d7eb2b 100644 --- a/README.md +++ b/README.md @@ -49,24 +49,12 @@ The high-level architecture and main process flow is as follows: SuperSonic comes with sample semantic models as well as chat conversations that can be used as a starting point. Please follow the steps: - Download the latest prebuilt binary from the [release page](https://github.com/tencentmusic/supersonic/releases) -- Run script "bin/start-standalone.sh" to start a standalone server +- Run script "bin/start-standalone.sh" to start services (one java process and one python process) - Visit http://localhost:9080 in the browser to start exploration -## How to Build +## Build and Delopment -SuperSonic can be deployed in two modes: standalone (for a quick demo) and distributed (for production use). - -### Build for Standalone Mode - -Pull the source code and run script "assembly/bin/build-standalone.sh" to build a single packages. - -### Build for Distributed Mode - -Pull the source code and run scripts "assembly/bin/build-chat.sh" and "assembly/bin/build-semantic.sh" separately to build packages. - -### Build for Local Development - -Pull the source code and run script "assembly/bin/build-ide.sh" and run bootstrap class "StandaloneLauncher" in the IDE. +Please refer to project [wiki](https://github.com/tencentmusic/supersonic/wiki). ## WeChat Contact diff --git a/README_CN.md b/README_CN.md index d9ae59e12..e76e6387b 100644 --- a/README_CN.md +++ b/README_CN.md @@ -47,24 +47,12 @@ 超音数自带样例的语义模型和问答对话,只需以下三步即可快速体验: - 从[release page](https://github.com/tencentmusic/supersonic/releases)下载预先构建好的发行包 -- 运行 "bin/start-standalone.sh"启动服务 +- 运行 "bin/start-standalone.sh"启动服务(一个Java进程和一个Python进程) - 在浏览器访问http://localhost:9080 开启探索 -## 如何构建 +## 如何构建和部署 -超音数可以运行在两个模式:standalone(一般用于快速演示)和distributed(一般用于生产环境)。 - -### Standalone模式构建 - -下载源码包,运行脚本"assembly/bin/build-standalone.sh",将所有服务一起编译打包。 - -### Distributed模式构建 - -下载源码包,分别运行脚本"assembly/bin/build-chat.sh"、"assembly/bin/build-semantic.sh",为问答层服务和语义层服务编译打包。 - -### 本地开发构建 - -下载源码包,运行脚本"assembly/bin/build-ide.sh",然后在本地IDE运行启动类"StandaloneLauncher"。 +请参考项目[wiki](https://github.com/tencentmusic/supersonic/wiki)。 ## 微信联系方式