Skip to content

Commit 7b4f504

Browse files
committed
doc(godel-script): Streamline the content about the compilation environment and steps in README.
1 parent 37a97cc commit 7b4f504

File tree

1 file changed

+6
-44
lines changed

1 file changed

+6
-44
lines changed

godel-script/README.md

+6-44
Original file line numberDiff line numberDiff line change
@@ -56,51 +56,13 @@ Structure of this project:
5656

5757
Need C++ standard at least `-std=c++17`.
5858

59-
You can refer to the following Dockerfile to prepare your development environment.
59+
On Ubuntu, you are expected to install the following packages before compiling.
6060

61-
```Dockerfile
62-
FROM ubuntu:24.04
63-
64-
RUN echo "Types: deb\n\
65-
URIs: http://mirrors.cloud.tencent.com/ubuntu/\n\
66-
Suites: noble noble-updates noble-security\n\
67-
Components: main restricted universe multiverse\n\
68-
Signed-By: /usr/share/keyrings/ubuntu-archive-keyring.gpg" > /etc/apt/sources.list.d/ubuntu.sources
69-
70-
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
61+
```bash
62+
sudo apt install -y git build-essential libffi-dev m4 cmake libsqlite3-dev zlib1g-dev
7163
```
7264

73-
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`.
74-
75-
```json
76-
{
77-
"name": "godel-script",
78-
"build": {
79-
"context": "..",
80-
"dockerfile": "./Dockerfile"
81-
},
82-
"customizations": {
83-
"vscode": {
84-
"extensions": [
85-
"xaver.clang-format",
86-
"twxs.cmake",
87-
"ms-vscode.cmake-tools",
88-
"vadimcn.vscode-lldb",
89-
"llvm-vs-code-extensions.vscode-clangd"
90-
],
91-
"settings": {
92-
"[cpp]": {
93-
"editor.defaultFormatter": "xaver.clang-format"
94-
},
95-
"editor.formatOnSave": true,
96-
"editor.formatOnPaste": true,
97-
"cmake.generator": "Ninja"
98-
}
99-
}
100-
},
101-
"remoteUser": "root"
102-
}
103-
```
65+
For convenience, we recommend directly using the [Dev Container plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) of VSCode. The configuration files are in `godel-script/.devcontainer/`.
10466

10567

10668
### Apply Patch On Soufflé Submodule
@@ -133,8 +95,8 @@ Use command below:
13395

13496
```bash
13597
mkdir build && cd build
136-
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
137-
cmake --build . --config Release --target all -j 8
98+
cmake .. -DCMAKE_BUILD_TYPE:STRING=Release
99+
cmake --build .
138100
```
139101

140102
After building, you'll find `build/godel` in the `build` folder.

0 commit comments

Comments
 (0)