Skip to content

Commit

Permalink
Set up KeYmaeraX-projects repo as git submodule
Browse files Browse the repository at this point in the history
This documents the exact version of the KeYmaeraX-projects repo used at
all points in time. It also simplifies the repo setup.
  • Loading branch information
Joscha Mennicken authored and EnguerrandPrebet committed May 24, 2024
1 parent 2e9ac55 commit a72191d
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 17 deletions.
6 changes: 1 addition & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,8 @@ jobs:
steps:
- name: Checkout source code
uses: actions/checkout@v4

- name: Checkout example projects
uses: actions/checkout@v4
with:
repository: LS-Lab/KeYmaeraX-projects
path: keymaerax-webui/src/main/resources/keymaerax-projects
submodules: recursive

- name: Set up java and sbt
uses: actions/setup-java@v4
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ target/

# Files required for building that should not be committed
/local.properties
/keymaerax-webui/src/main/resources/keymaerax-projects/
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "KeYmaeraX-projects"]
path = keymaerax-webui/src/main/resources/keymaerax-projects
url = https://github.com/LS-Lab/KeYmaeraX-projects.git
18 changes: 7 additions & 11 deletions doc/procedures.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ Install the following tools:

### 2. Clone this repo

Assuming you have not already done so, clone this repo to a path of your choice.
Assuming you have not already done so, clone this repo with `--recurse-submodules`:

```shell
git clone https://github.com/LS-Lab/KeYmaeraX-release.git --recurse-submodules
```

Any commands in this guide assume they're being executed in the root of the repository unless specified otherwise.

Some commits should be omitted from `git blame` by default
Expand All @@ -29,16 +34,7 @@ To configure your local repository to ignore them, use the following command:
git config blame.ignoreRevsFile .git-blame-ignore-revs
```

### 3. Clone example projects

Clone the [KeYmaeraX-projects](https://github.com/LS-Lab/KeYmaeraX-projects) repo
to `keymaerax-webui/src/main/resources/keymaerax-projects` using the following command:

```shell
git clone https://github.com/LS-Lab/KeYmaeraX-projects keymaerax-webui/src/main/resources/keymaerax-projects
```

### 4. Prepare `local.properties`
### 3. Prepare `local.properties`

KeYmaera X has optional support of Wolfram Mathematica or Wolfram Engine at runtime.
However, during compilation, Mathematica's `JLink.jar` file is required.
Expand Down
1 change: 1 addition & 0 deletions keymaerax-webui/src/main/resources/keymaerax-projects
Submodule keymaerax-projects added at 08f4a5

0 comments on commit a72191d

Please sign in to comment.