Skip to content

Commit dbf02c7

Browse files
hongzhi-gaohongzhi-gao
authored
fix readme logo (#727)
1 parent 8da8575 commit dbf02c7

8 files changed

Lines changed: 182 additions & 78 deletions

File tree

‎README-zh.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,14 @@
2121

2222
[English](./README.md) | [中文](./README-zh.md)
2323
# TsFile Document
24-
<pre>
25-
___________ ___________.__.__
26-
\__ ___/____\_ _____/|__| | ____
27-
| | / ___/| __) | | | _/ __ \
28-
| | \___ \ | \ | | |_\ ___/
29-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
30-
\/ \/ \/
31-
</pre>
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
29+
3230
[![codecov](https://codecov.io/github/apache/tsfile/graph/badge.svg?token=0Y8MVAB3K1)](https://codecov.io/github/apache/tsfile)
33-
[![Maven Version](https://maven-badges.herokuapp.com/maven-central/org.apache.tsfile/tsfile-parent/badge.svg)](http://search.maven.org/#search|gav|1|g:"org.apache.tsfile")
31+
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.tsfile/tsfile-parent.svg)](https://central.sonatype.com/artifact/org.apache.tsfile/tsfile-parent)
3432

3533
## 简介
3634

‎README.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,15 @@
2121

2222
[English](./README.md) | [中文](./README-zh.md)
2323
# TsFile Document
24-
<pre>
25-
___________ ___________.__.__
26-
\__ ___/____\_ _____/|__| | ____
27-
| | / ___/| __) | | | _/ __ \
28-
| | \___ \ | \ | | |_\ ___/
29-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
30-
\/ \/ \/
31-
</pre>
32-
[![codecov](https://codecov.io/github/apache/tsfile/graph/badge.svg?token=0Y8MVAB3K1)](https://codecov.io/github/apache/tsfile)
33-
[![Maven Version](https://maven-badges.herokuapp.com/maven-central/org.apache.tsfile/tsfile-parent/badge.svg)](http://search.maven.org/#search|gav|1|g:"org.apache.tsfile")
3424

25+
<p align="center">
26+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
27+
alt="TsFile Logo"
28+
width="400"/>
29+
</p>
30+
31+
[![codecov](https://codecov.io/github/apache/tsfile/graph/badge.svg?token=0Y8MVAB3K1)](https://codecov.io/github/apache/tsfile)
32+
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.tsfile/tsfile-parent.svg)](https://central.sonatype.com/artifact/org.apache.tsfile/tsfile-parent)
3533
## Introduction
3634

3735
TsFile is a columnar storage file format designed for time series data, which supports efficient compression, high throughput of read and write, and compatibility with various frameworks, such as Spark and Flink. It is easy to integrate TsFile into IoT big data processing frameworks.

‎cpp/README-zh.md‎

Lines changed: 99 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,102 @@
1919
2020
-->
2121

22-
# TsFile C++ Document
23-
<pre>
24-
___________ ___________.__.__
25-
\__ ___/____\_ _____/|__| | ____
26-
| | / ___/| __) | | | _/ __ \
27-
| | \___ \ | \ | | |_\ ___/
28-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
29-
\/ \/ \/
30-
</pre>
31-
32-
## 使用
33-
34-
## 开发
22+
# TsFile C++ 文档
23+
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
29+
30+
## 简介
31+
32+
本目录包含 TsFile 的 C++ 实现版本。目前，C++ 版本支持 TsFile 的查询与写入功能，包括基于时间过滤的查询。
33+
34+
源代码位于 `./src` 目录。
35+
C/C++ 示例代码位于 `./examples` 目录。
36+
TsFile_cpp 的性能基准测试位于 `./bench_mark` 目录。
37+
38+
此外，在 `./src/cwrapper` 目录中提供了 C 函数封装接口，Python 工具依赖该封装。
39+
40+
---
41+
42+
## 如何贡献
43+
44+
我们使用 `clang-format` 来确保 C++ 代码遵循 `./clang-format` 文件中定义的一致规范（类似于 Google 风格）。
45+
46+
欢迎提交任何 Bug 报告。
47+
你可以创建一个以 `[CPP]` 开头的 Issue 来描述问题，例如：
48+
https://github.com/apache/tsfile/issues/94
49+
50+
---
51+
52+
## 构建
53+
54+
### 环境要求
55+
56+
```bash
57+
sudo apt-get update
58+
sudo apt-get install -y cmake make g++ clang-format libuuid-dev
59+
```
60+
61+
构建 tsfile：
62+
63+
```bash
64+
bash build.sh
65+
```
66+
67+
如果你安装了 Maven 工具，也可以运行：
68+
69+
```bash
70+
mvn package -P with-cpp clean verify
71+
```
72+
73+
构建完成后，可在 `./build` 目录下找到生成的共享库文件。
74+
75+
在向 GitHub 提交代码之前，请确保 `mvn` 编译通过。
76+
77+
---
78+
79+
### Windows 下 MinGW 编译问题
80+
81+
如果你在 Windows 下使用 MinGW 编译时遇到错误，可以尝试使用以下我们验证通过的版本：
82+
83+
- GCC 14.2.0（**POSIX** 线程） + LLVM/Clang/LLD/LLDB 18.1.8 + MinGW-w64 12.0.0 UCRT - release 1
84+
- GCC 12.2.0 + LLVM/Clang/LLD/LLDB 16.0.0 + MinGW-w64 10.0.0（UCRT）- release 5
85+
- GCC 12.2.0 + LLVM/Clang/LLD/LLDB 16.0.0 + MinGW-w64 10.0.0（MSVCRT）- release 5
86+
- GCC 11.2.0 + MinGW-w64 10.0.0（MSVCRT）- release 1
87+
88+
---
89+
90+
## 配置交叉编译工具链
91+
92+
修改工具链文件 `cmake/ToolChain.cmake`，定义以下变量：
93+
94+
- `CMAKE_C_COMPILER`：指定 C 编译器路径。
95+
- `CMAKE_CXX_COMPILER`：指定 C++ 编译器路径。
96+
- `CMAKE_FIND_ROOT_PATH`：设置交叉编译环境的根路径（例如交叉编译工具链目录）。
97+
98+
在 `cpp/` 目录下执行以下命令创建构建目录并开始编译：
99+
100+
```bash
101+
mkdir build && cd build
102+
cmake .. -DToolChain=ON
103+
make
104+
```
105+
106+
---
107+
108+
## 使用 TsFile
109+
110+
你可以在 `./examples/cpp_examples` 目录下的 `demo_read.cpp` 和 `demo_write.cpp` 中查看读写数据的示例。
111+
112+
在 `./examples/c_examples` 目录下，还提供了使用 C 风格 API 在 C 环境中读写数据的示例。
113+
114+
在 `./examples` 目录下执行：
115+
116+
```bash
117+
bash build.sh
118+
```
119+
120+
即可在 `./examples/build` 目录下生成可执行文件。

‎cpp/README.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,11 @@
2121

2222
# TsFile C++ Document
2323

24-
<pre>
25-
___________ ___________.__.__
26-
\__ ___/____\_ _____/|__| | ____
27-
| | / ___/| __) | | | _/ __ \
28-
| | \___ \ | \ | | |_\ ___/
29-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
30-
\/ \/ \/
31-
</pre>
32-
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
3329

3430
## Introduction
3531

‎java/tsfile/README-zh.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,11 @@
2121

2222
[English](./README.md) | [中文](./README-zh.md)
2323
# TsFile Java Document
24-
<pre>
25-
___________ ___________.__.__
26-
\__ ___/____\_ _____/|__| | ____
27-
| | / ___/| __) | | | _/ __ \
28-
| | \___ \ | \ | | |_\ ___/
29-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
30-
\/ \/ \/
31-
</pre>
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
3229

3330
## 使用
3431

‎java/tsfile/README.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,11 @@
2121

2222
[English](./README.md) | [中文](./README-zh.md)
2323
# TsFile Java Document
24-
<pre>
25-
___________ ___________.__.__
26-
\__ ___/____\_ _____/|__| | ____
27-
| | / ___/| __) | | | _/ __ \
28-
| | \___ \ | \ | | |_\ ___/
29-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
30-
\/ \/ \/
31-
</pre>
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
3229

3330
## Use TsFile
3431

‎python/README-zh.md‎

Lines changed: 48 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,51 @@
1919
2020
-->
2121

22-
# TsFile Python Document
23-
<pre>
24-
___________ ___________.__.__
25-
\__ ___/____\_ _____/|__| | ____
26-
| | / ___/| __) | | | _/ __ \
27-
| | \___ \ | \ | | |_\ ___/
28-
|____|/____ >\___ / |__|____/\___ > version 21.0
29-
\/ \/ \/
30-
</pre>
31-
32-
## 使用
33-
34-
## 开发
22+
# TsFile Python 文档
23+
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
29+
30+
## 简介
31+
32+
本目录包含 TsFile 的 Python 实现版本。Python 版本基于 C++ 版本构建，并通过 Cython 包将 TsFile 的读写能力集成到 Python 环境中。用户可以像在 Pandas 中使用 read_csv 和 write_csv 一样，方便地读取和写入 TsFile。
33+
34+
源代码位于 `./tsfile` 目录。
35+
以 `.pyx` 和 `.pyd` 结尾的文件为使用 Cython 编写的封装代码。
36+
`tsfile/tsfile.py` 中定义了一些对用户开放的接口。
37+
38+
你可以在 `./examples/examples.py` 中找到读写示例。
39+
40+
---
41+
42+
## 如何贡献
43+
44+
建议使用 pylint 对 Python 代码进行检查。
45+
46+
目前尚无合适的 Cython 代码风格检查工具，因此 Cython 部分代码应遵循 pylint 所要求的 Python 代码风格。
47+
48+
**功能列表**
49+
50+
- [ ] 在 pywrapper 中调用 TsFile C++ 版本实现的批量读取接口。
51+
- [ ] 支持将多个 DataFrame 写入同一个 TsFile 文件。
52+
53+
---
54+
55+
## 构建
56+
57+
在构建 TsFile 的 Python 版本之前，必须先构建 [TsFile C++ 版本](../cpp/README.md)，因为 Python 版本依赖于 C++ 版本生成的共享库文件。
58+
59+
### 使用 Maven 在根目录构建
60+
61+
```sh
62+
mvn -P with-cpp,with-python clean verify
63+
```
64+
65+
### 使用 Python 命令构建
66+
67+
```sh
68+
python setup.py build_ext --inplace
69+
```

‎python/README.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,11 @@
2121

2222
# TsFile Python Document
2323

24-
<pre>
25-
___________ ___________.__.__
26-
\__ ___/____\_ _____/|__| | ____
27-
| | / ___/| __) | | | _/ __ \
28-
| | \___ \ | \ | | |_\ ___/
29-
|____|/____ >\___ / |__|____/\___ > version 2.1.0
30-
\/ \/ \/
31-
</pre>
24+
<p align="center">
25+
<img src="https://www.apache.org/logos/originals/tsfile.svg"
26+
alt="TsFile Logo"
27+
width="400"/>
28+
</p>
3229

3330

3431
## Introduction

0 commit comments

Comments
 (0)