-
Notifications
You must be signed in to change notification settings - Fork 34
doc(godel-script): Provide supplementary explanations regarding the c... #101
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
Conversation
...ompilation environment and steps in README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
其他修改部分非常完美,但是部分信息仍然需要调节一下。
godel-script/README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
为了配合目前项目配置的 CI,建议仍然使用 cmake 与 make,没有特殊需求尽量不要增加其他实体
godel-script/README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里描述还是尽量简洁一些,去除不必要的信息噪音,只保留当时我们讨论的核心问题,也就是将 ubuntu 环境下编译时可能缺少的相关包在这里列出来,在系统方面目前项目支持 macOS / Ubuntu 2204 LTS / Ubuntu 2404 LTS 的本地编译,环境尽量不要限制死。
godel-script/README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
devcontainer 虽然很有用,但是这里还是请去掉吧,对于文档来说信息过多了
建议把dockerfile独立为一个文件。不要放到readme里作为文本存在,这样使用不方便且影响readme可读性。devcontainer同理。
...onment and steps in README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
#100