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.

Sign up for GitHub

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

doc(godel-script): Provide supplementary explanations regarding the c… #101

Merged
merged 2 commits into from
Mar 11, 2025
Merged

doc(godel-script): Provide supplementary explanations regarding the c… #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37a97cc
doc(godel-script): Provide supplementary explanations regarding the c…
11D-Beyonder Mar 3, 2025
7b4f504
doc(godel-script): Streamline the content about the compilation envir…
11D-Beyonder Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions godel-script/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,24 +52,39 @@ Structure of this project:
+-- src godel-frontend source code
```

### Environment

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

On Ubuntu, you are expected to install the following packages before compiling.

```bash
sudo apt install -y git build-essential libffi-dev m4 cmake libsqlite3-dev 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. The configuration files are in `godel-script/.devcontainer/`.


### Apply Patch On Soufflé Submodule

GödelScript uses a self-modified soufflé from a much older branch of public soufflé,
now we use patch to make sure it could be built successfully.
GödelScript uses a self-modified soufflé from a much older branch of public soufflé. Use these commands to clone.

```bash
git submodule init
git submodule update --recursive
```

Use this command to apply patch:
Now we use patch to make sure it could be built successfully. Use these commands to apply patch:

```bash
cd souffle
cd godel-backend/souffle
git am ../0001-init-self-used-souffle-from-public-souffle.patch
```

Use these commands to revert:

```bash
cd souffle
cd godel-backend/souffle
git apply -R ../0001-init-self-used-souffle-from-public-souffle.patch
git reset HEAD~
```
Expand All @@ -79,8 +94,9 @@ git reset HEAD~
Use command below:

```bash
mkdir build && cd build && cmake .. -DCMAKE_BUILD_TYPE=Release
make -j6
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE:STRING=Release
cmake --build .
```

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