Skip to content

Commit ff06e4d

Browse files
committed
docs: add simplicity code update instructions
1 parent e3cec16 commit ff06e4d

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

doc/simplicity-c-code-update.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Updating Simplicity C code in Elements
2+
3+
This document describes how to update the Simplicity C code subtree in the Elements repository.
4+
5+
Reference: https://github.com/BlockstreamResearch/simplicity/issues/329#issuecomment-3715844042
6+
7+
## Simplicity
8+
9+
- Clone or pull the latest `master` branch of the [Simplicity](https://github.com/BlockstreamResearch/simplicity) repository.
10+
11+
- Split out a new subtree of the Simplicity `C` source to the `C-master` branch.
12+
13+
```
14+
git subtree split -P C -b C-master
15+
```
16+
17+
- Push the `C-master` branch to a public remote.
18+
19+
```
20+
git push <remote> C-master
21+
```
22+
23+
## Elements
24+
25+
- Add a reference to the above simplicity remote in your Elements repo.
26+
27+
```
28+
git remote add <new-remote-name> git@github.com:<user>/simplicity.git
29+
```
30+
31+
- Pull and squash the `C-master` branch subtree into the `src/simplicity` directory in Elements.
32+
33+
```
34+
git subtree pull --prefix src/simplicity <new-remote-name> C-master --squash
35+
```
36+
37+
- Run build and tests.
38+
39+
- Create a new PR to Elements.

0 commit comments

Comments
 (0)