Skip to content

Commit 815b948

Browse files
committed
docs: update readme
Signed-off-by: Alex Chi <[email protected]>
1 parent e75123c commit 815b948

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# RisingLight Tutorial
1+
# [RisingLight Tutorial](https://risinglightdb.github.io/risinglight-tutorial)
22

3-
[![CI](https://github.com/singularity-data/risinglight-tutorial/workflows/CI/badge.svg?branch=main)](https://github.com/singularity-data/risinglight-tutorial/actions)
3+
🚧🚧🚧🚧🚧🚧🚧 UNDER CONSTRUCTION 🚧🚧🚧🚧🚧🚧🚧
44

5-
Let's build an OLAP database from scratch!
5+
[![CI](https://github.com/risinglightdb/risinglight-tutorial/workflows/CI/badge.svg?branch=main)](https://github.com/risinglightdb/risinglight-tutorial/actions)
6+
7+
This repo contains a series of tutorial that help you build an OLAP database system like RisingLight. The tutorial is currently only offered in Simplified Chinese. Let's build an OLAP database from scratch!
8+
9+
**[See it in Action!](https://risinglightdb.github.io/risinglight-tutorial)**
10+
11+
View the [tracking issue](https://github.com/risinglightdb/risinglight-tutorial/issues/1) for the current progress.
612

713
## Building
814

docs/src/01-01-hello-sql.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ SELECT 1 # 输入的 SQL 语句
5656

5757
我们的 RisingLight 就使用了 sqllogictest 来做端到端测试。你可以在 [`code/sql`] 文件夹下找到每个任务对应的 sqllogictest 测试脚本。
5858

59-
[`code/sql`]: https://github.com/singularity-data/risinglight-tutorial/tree/main/code/sql
59+
[`code/sql`]: https://github.com/risinglightdb/risinglight-tutorial/tree/main/code/sql
6060

6161
### Rust
6262

@@ -88,7 +88,7 @@ Hello, world!
8888

8989
除此之外,我们还要搭起一个端到端测试框架,能够运行第一个 sqllogictest 脚本:[`01-01.slt`]
9090

91-
[`01-01.slt`]: https://github.com/singularity-data/risinglight-tutorial/tree/main/code/sql/01-01.slt
91+
[`01-01.slt`]: https://github.com/risinglightdb/risinglight-tutorial/tree/main/code/sql/01-01.slt
9292

9393

9494
## 整体设计
@@ -325,7 +325,7 @@ fn test() {
325325
[sqllogictest]: https://docs.rs/sqllogictest/0.1.0/sqllogictest/
326326
[`DB`]: https://docs.rs/sqllogictest/0.1.0/sqllogictest/trait.DB.html
327327
[`Runner`]: https://docs.rs/sqllogictest/0.1.0/sqllogictest/struct.Runner.html#method.run_script
328-
[test.rs]: https://github.com/singularity-data/risinglight-tutorial/tree/main/code/01-01/src/test.rs
328+
[test.rs]: https://github.com/risinglightdb/risinglight-tutorial/tree/main/code/01-01/src/test.rs
329329

330330
### 总结
331331

0 commit comments

Comments
 (0)