doc(godel-script): Provide supplementary explanations regarding the c… #101
+23
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ompilation environment and steps in README.
ValKmjolnir
requested changes
Mar 3, 2025
godel-script/README.md
Outdated
| mkdir build && cd build && cmake .. -DCMAKE_BUILD_TYPE=Release | ||
| make -j6 | ||
| mkdir build && cd build | ||
| cmake .. -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE -DCMAKE_C_COMPILER:FILEPATH=/usr/bin/clang -DCMAKE_CXX_COMPILER:FILEPATH=/usr/bin/clang++ --no-warn-unused-cli -G Ninja |
There was a problem hiding this comment.
为了配合目前项目配置的 CI，建议仍然使用 cmake 与 make，没有特殊需求尽量不要增加其他实体
godel-script/README.md
Outdated
| Need C++ standard at least `-std=c++17`. | ||
|
|
||
| You can refer to the following Dockerfile to prepare your development environment. | ||
|
|
||
| ```Dockerfile |
There was a problem hiding this comment.
这里描述还是尽量简洁一些，去除不必要的信息噪音，只保留当时我们讨论的核心问题，也就是将 ubuntu 环境下编译时可能缺少的相关包在这里列出来，在系统方面目前项目支持 macOS / Ubuntu 2204 LTS / Ubuntu 2404 LTS 的本地编译，环境尽量不要限制死。
godel-script/README.md
Outdated
| RUN apt update && apt upgrade -y && apt install -y git build-essential m4 cmake ninja-build clang-format clang-tidy clang-tools clang clangd libc++-dev libc++1 libc++abi-dev libc++abi1 libclang-dev libclang1 liblldb-dev libllvm-ocaml-dev libomp-dev libomp5 lld lldb llvm-dev llvm-runtime llvm python3-clang libsqlite3-dev sqlite3 zlib1g-dev | ||
| ``` | ||
|
|
||
| For convenience, we recommend directly using the [Dev Container plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) of VSCode. Here is `devcontainer.json`. |
There was a problem hiding this comment.
devcontainer 虽然很有用，但是这里还是请去掉吧，对于文档来说信息过多了
|
建议把dockerfile独立为一个文件。不要放到readme里作为文本存在，这样使用不方便且影响readme可读性。devcontainer同理。 |
…onment and steps in README.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#100