Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build:Update README,modify build script,add compilation information #252

Merged
merged 5 commits into from
Apr 3, 2024

Conversation

lqxhub
Copy link
Collaborator

@lqxhub lqxhub commented Apr 1, 2024

更新README文档, 修改构建脚本,去掉之前报错的内容

在cmake中传递宏,对生成的二进制文件添加编译信息

效果:
image

修改 判断GCC版本, clang没有环境测试,最低版本检测部分没改

@github-actions github-actions bot added ✏️ Feature New feature or request 📒 Documentation Improvements or additions to documentation 🧹 Updates This will not be worked on labels Apr 1, 2024
README.md Outdated
Execute compilation

If the machine's GCC version is less than 11, especially on CentOS6 or CentOS7, you need to upgrade the gcc version
first.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 first -> firstly
2 没必要另起一行,放在 line 18 最后即可。

README.md Outdated Show resolved Hide resolved
README_CN.md Outdated
@@ -2,12 +2,42 @@
![](docs/images/pikiwidb-logo.png)
[Click me switch to English](README.en.md)

C++11实现的增强版Redis服务器,使用RocksDB作为持久化存储引擎。(集群支持尚正在计划中)
C++20实现的增强版Redis服务器,使用RocksDB作为持久化存储引擎。(集群支持尚正在计划中)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C++20 实现的增强版Redis服务器,使用 RocksDB 作为持久化存储引擎。(集群支持尚正在计划中)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

注意中文文档规范:英文或者数字前后各放上一个 英文空格

README_CN.md Outdated
* Linux 或 MAC OS

## 编译

**建议使用最新版本的Ubuntu或Debian Linux系统**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

建议使用最新版本的 Ubuntu 或 Debian Linux 系统

README_CN.md Outdated

执行编译:

如果机器的GCC版本低于11,特别是在CentOS6或CentOS7上,你需要先升级gcc版本。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

如果机器的 GCC 版本低于 11,特别是在 CentOS 6.x 或 CentOS 7.x 上,你需要先升级 gcc 版本

README_CN.md Outdated

如果机器的GCC版本低于11,特别是在CentOS6或CentOS7上,你需要先升级gcc版本。

在CentOS上执行以下命令:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

在 CentOS 上执行以下命令

README_CN.md Outdated
scl enable devtoolset-11 bash
```

执行以下命令开始编译Pikiwidb:
Copy link
Contributor

@AlexStocks AlexStocks Apr 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

执行以下命令开始编译 PikiwiDB:

README_CN.md Outdated
./build.sh
```

Pikiwidb默认以release模式编译,不支持调试。如果需要调试,请以debug模式编译。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PikiwiDB 默认以 release 模式编译,不支持调试。如果需要调试,请以 debug 模式编译。

README_CN.md Outdated Show resolved Hide resolved
@lqxhub
Copy link
Collaborator Author

lqxhub commented Apr 2, 2024

@AlexStocks 统一回复, 问题都已修复

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


@AlexStocks responded uniformly, the problems have been fixed

README_CN.md Outdated
@@ -2,44 +2,81 @@
![](docs/images/pikiwidb-logo.png)
[Click me switch to English](README.en.md)

C++11实现的增强版Redis服务器,使用RocksDB作为持久化存储引擎。(集群支持尚正在计划中)
C++20实现的增强版 Redis 服务器,使用 RocksDB 作为持久化存储引擎。(集群支持尚正在计划中)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C++20 后面加个空格

README_CN.md Outdated

执行编译:

如果机器的 GCC 版本低于 11,特别是在 CentOS 6.x 或 CentOS7.x 上,你需要先升级gcc版本。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

后面的 gcc 修改下

README_CN.md Outdated
你可以用 redis 的各种工具来测试 PikiwiDB,比如官方的 redis-cli, redis-benchmark。

PikiwiDB 可以和 redis 之间进行复制,可以读取 redis 的 rdb 文件或 aof 文件。当然,PikiwiDB 生成的 aof 或 rdb 文件也可以被
redis 读取。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

跟上面一行合并

README_CN.md Outdated
```bash
./redis-benchmark -q -n 1000000 -P 50 -c 50
```

## 编写扩展模块
PikiwiDB支持动态库模块,可以在运行时添加新命令。

PikiwiDB 支持动态库模块,可以在运行时添加新命令。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个功能暂时没支持,要不删了?

@AlexStocks AlexStocks merged commit fe91578 into OpenAtomFoundation:unstable Apr 3, 2024
5 checks passed
@lqxhub lqxhub deleted the compile branch April 3, 2024 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📒 Documentation Improvements or additions to documentation ✏️ Feature New feature or request 🧹 Updates This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants