Skip to content
Snippets Groups Projects
Unverified Commit cd971778 authored by prinz's avatar prinz Committed by GitHub
Browse files

update readme (#4586)

Approved by: @dengn
parent 583a4066
No related branches found
No related tags found
No related merge requests found
......@@ -14,11 +14,11 @@
<a href="https://www.codefactor.io/repository/github/matrixorigin/matrixone">
<img src="https://www.codefactor.io/repository/github/matrixorigin/matrixone/badge?s=7280f4312fca2f2e6938fb8de5b726c5252541f0" alt="codefactor"/>
</a>
<a href="https://docs.matrixorigin.io/0.5.0/MatrixOne/Release-Notes/v0.5.0/">
<img src="https://img.shields.io/badge/Release-v0.5.0-green.svg" alt="release"/>
<a href="https://docs.matrixorigin.io/0.5.1/MatrixOne/Release-Notes/v0.5.1/">
<img src="https://img.shields.io/badge/Release-v0.5.1-green.svg" alt="release"/>
</a>
<br>
<a href="https://docs.matrixorigin.io/0.5.0/">
<a href="https://docs.matrixorigin.io/0.5.1/">
<b>Docs</b>
</a>
<b>||</b>
......@@ -147,7 +147,7 @@ MatrixOne's architecture is as below:
<img alt="MatrixOne" height="500" src="https://github.com/matrixorigin/artwork/blob/main/docs/overview/matrixone_new_arch.png?raw=true">
</p>
For more details, you can checkout [MatrixOne Architecture](https://docs.matrixorigin.io/0.5.0/MatrixOne/Overview/matrixone-architecture/).
For more details, you can checkout [MatrixOne Architecture](https://docs.matrixorigin.io/0.5.1/MatrixOne/Overview/matrixone-architecture/).
## ⚡️ <a id="quick-start">Quick start</a>
......@@ -155,7 +155,7 @@ For more details, you can checkout [MatrixOne Architecture](https://docs.matrixo
### ⚙️ Install MatrixOne
MatrixOne supports Linux and MacOS. You can install MatrixOne either by [building from source](#building-from-source) or [using docker](#using-docker).
For other installation types, please refer to [MatrixOne installation](https://docs.matrixorigin.io/0.5.0/MatrixOne/Get-Started/install-standalone-matrixone/) for more details.
For other installation types, please refer to [MatrixOne installation](https://docs.matrixorigin.io/0.5.1/MatrixOne/Get-Started/install-standalone-matrixone/) for more details.
#### **Building from source**
1. Install Go (version 1.18 is required).
......@@ -173,11 +173,11 @@ $ cd matrixone
- *Option 2*: Get the MatrixOne(Stable Version) code
If you want to get the latest stable version code released by MatrixOne, please switch to the branch of version **0.5.0** first.
If you want to get the latest stable version code released by MatrixOne, please switch to the branch of version **0.5.1** first.
```
$ git clone https://github.com/matrixorigin/matrixone.git
$ git checkout 0.5.0
$ git checkout 0.5.1
$ cd matrixone
```
......@@ -214,10 +214,18 @@ It will pull the image from Docker Hub if not exists. You can choose to pull the
$ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:latest
```
- 0.5.0 Version Image
- 0.5.1 Version Image
```
$ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:0.5.0
$ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:0.5.1
```
3. Mount the data directory(Optional)
To customize the configuration file, you can mount the custom configuration file stored on the local disk.
```
docker run -d -p 6001:6001 -v ${path_name}/system_vars_config.toml:/system_vars_config.toml:ro -v ${path_name}/store:/store:rw --name matrixone matrixorigin/matrixone:0.5.1
```
### 🌟 Connecting to MatrixOne server
......@@ -251,7 +259,7 @@ Now, MatrixOne only supports the TCP listener.
## 🙌 <a id="contributing">Contributing</a>
Contributions to MatrixOne are welcome from everyone.
See [Contribution Guide](https://docs.matrixorigin.io/0.5.0/MatrixOne/Contribution-Guide/make-your-first-contribution/) for details on submitting patches and the contribution workflow.
See [Contribution Guide](https://docs.matrixorigin.io/0.5.1/MatrixOne/Contribution-Guide/make-your-first-contribution/) for details on submitting patches and the contribution workflow.
### 👏 All contributors
......
......@@ -13,11 +13,11 @@
<a href="https://www.codefactor.io/repository/github/matrixorigin/matrixone">
<img src="https://www.codefactor.io/repository/github/matrixorigin/matrixone/badge?s=7280f4312fca2f2e6938fb8de5b726c5252541f0" alt="codefactor"/>
</a>
<a href="https://docs.matrixorigin.io/0.5.0/MatrixOne/Release-Notes/v0.5.0/">
<img src="https://img.shields.io/badge/Release-v0.5.0-green.svg" alt="release"/>
<a href="https://docs.matrixorigin.io/0.5.1/MatrixOne/Release-Notes/v0.5.1/">
<img src="https://img.shields.io/badge/Release-v0.5.1-green.svg" alt="release"/>
</a>
<br>
<a href="https://docs.matrixorigin.io/cn/0.5.0/">
<a href="https://docs.matrixorigin.io/cn/0.5.1/">
<b>Docs</b>
</a>
<b>||</b>
......@@ -139,13 +139,13 @@ MatrixOne的架构图如下图所示:
<img alt="MatrixOne" height="500" src="https://github.com/matrixorigin/artwork/blob/main/docs/overview/matrixone_new_arch.png?raw=true">
</p>
关于更详细的MatrixOne技术架构,可以参考[MatrixOne架构](https://docs.matrixorigin.io/cn/0.5.0/MatrixOne/Overview/matrixone-architecture/)
关于更详细的MatrixOne技术架构,可以参考[MatrixOne架构](https://docs.matrixorigin.io/cn/0.5.1/MatrixOne/Overview/matrixone-architecture/)
## ⚡️ <a id="quick-start">快速上手</a>
### ⚙️ 安装MatrixOne
MatrixOne目前支持Linux及MacOS系统,您可以通过源码安装或者docker安装。其他安装方式请参见[MatrixOne安装指南](https://docs.matrixorigin.io/cn/0.5.0/MatrixOne/Get-Started/install-standalone-matrixone/)
MatrixOne目前支持Linux及MacOS系统,您可以通过源码安装或者docker安装。其他安装方式请参见[MatrixOne安装指南](https://docs.matrixorigin.io/cn/0.5.1/MatrixOne/Get-Started/install-standalone-matrixone/)
#### 使用源代码搭建
......@@ -168,11 +168,11 @@ $ cd matrixone
- *选项 2*:获取 MatrixOne(稳定版本) 代码
如果您想获得 MatrixOne 发布的最新稳定版本代码,请先从 **main** 切换选择至 **0.5.0** 版本分支。
如果您想获得 MatrixOne 发布的最新稳定版本代码,请先从 **main** 切换选择至 **0.5.1** 版本分支。
```
$ git clone https://github.com/matrixorigin/matrixone.git
$ git checkout 0.5.0
$ git checkout 0.5.1
$ cd matrixone
```
......@@ -209,15 +209,23 @@ $ docker --version
$ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:latest
```
- 0.5.0 稳定版本的镜像
- 0.5.1 稳定版本的镜像
```
$ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:0.5.0
$ docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:0.5.1
```
运行 Docker Hub 时需要输入用户名和密码,获取用户名和密码可以参考下一步骤 - 连接 MatrixOne 服务。
运行 Docker Hub 时需要输入用户名和密码,获取用户名和密码可以参考**连接 MatrixOne 服务**章节所述
### 🌟 连接MatrixOne服务
**步骤 3.** 挂载数据(选做)
如果你需要自定义配置文件或者数据目录,可以直接挂载存放在本地磁盘的自定义配置文件:
```
docker run -d -p 6001:6001 -v ${path_name}/system_vars_config.toml:/system_vars_config.toml:ro -v ${path_name}/store:/store:rw --name matrixone matrixorigin/matrixone:0.5.1
```
### 🌟 连接 MatrixOne 服务
1. 安装MySQL客户端
......@@ -248,7 +256,7 @@ Enter password:
## 🙌 <a id="contributing">参与贡献</a>
欢迎大家对MatrixOne的贡献。
请查看[贡献指南](https://docs.matrixorigin.io/cn/0.5.0/MatrixOne/Contribution-Guide/make-your-first-contribution/)来了解有关提交补丁和完成整个贡献流程的详细信息。
请查看[贡献指南](https://docs.matrixorigin.io/cn/0.5.1/MatrixOne/Contribution-Guide/make-your-first-contribution/)来了解有关提交补丁和完成整个贡献流程的详细信息。
### 👏贡献者们
......
......@@ -13,5 +13,5 @@ MatrixOne通过超融合数据引擎实现单一数据库系统支持事务性
| 概述 | 快速上手 | 参考指南
| ---- | ---- | ----
| [MatrixOne简介](MatrixOne/Overview/matrixone-introduction.md) | [MatrixOne安装部署](MatrixOne/Get-Started/install-standalone-matrixone.md) | [SQL参考指南](MatrixOne/Reference/SQL-Reference/Data-Definition-Statements/create-database.md)
| [MatrixOne架构](MatrixOne/Overview/matrixone-architecture.md) | [连接MatrixOne服务](MatrixOne/Get-Started/connect-to-matrixone-server.md) | [v0.5.0发布公告](MatrixOne/Release-Notes/v0.5.0.md)
| [MatrixOne架构](MatrixOne/Overview/matrixone-architecture.md) | [连接MatrixOne服务](MatrixOne/Get-Started/connect-to-matrixone-server.md) | [v0.5.1发布公告](MatrixOne/Release-Notes/v0.5.1.md)
| [MySQL兼容性](MatrixOne/Overview/mysql-compatibility.md) | [使用MatrixOne完成SSB测试](MatrixOne/Get-Started/Tutorial/SSB-test-with-matrixone.md)
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment