docs: add simplicity code update instructions
What the developer wrote
Authored by Byron Hambly
docs: add simplicity code update instructions
What changed, and why it matters
This commit only adds a new documentation file explaining how developers can update the Simplicity C code subtree in the Elements repository. It contains no code changes, no configuration changes, and no executable logic. There is no security-relevant change to the software itself.
No action required. Review and merge as normal documentation if the instructions are accurate and helpful for maintainers.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit introduces doc/simplicity-c-code-update.md, a 39-line markdown document describing the git subtree workflow for pulling Simplicity C source code into src/simplicity. The diff is purely documentation: shell command examples for git subtree split/push/remote-add/pull and instructions to build, test, and open a PR. No source code, build scripts, tests, or dependencies were modified.
Changed components
Inspect captured patch +39 / −0
diff --git a/doc/simplicity-c-code-update.md b/doc/simplicity-c-code-update.md
new file mode 100644
index 0000000..c6910a5
--- /dev/null
+++ b/doc/simplicity-c-code-update.md
@@ -0,0 +1,39 @@
+# Updating Simplicity C code in Elements
+
+This document describes how to update the Simplicity C code subtree in the Elements repository.
+
+Reference: https://github.com/BlockstreamResearch/simplicity/issues/329#issuecomment-3715844042
+
+## Simplicity
+
+- Clone or pull the latest `master` branch of the [Simplicity](https://github.com/BlockstreamResearch/simplicity) repository.
+
+- Split out a new subtree of the Simplicity `C` source to the `C-master` branch.
+
+```
+git subtree split -P C -b C-master
+```
+
+- Push the `C-master` branch to a public remote.
+
+```
+git push <remote> C-master
+```
+
+## Elements
+
+- Add a reference to the above simplicity remote in your Elements repo.
+
+```
+git remote add <new-remote-name> git@github.com:<user>/simplicity.git
+```
+
+- Pull and squash the `C-master` branch subtree into the `src/simplicity` directory in Elements.
+
+```
+git subtree pull --prefix src/simplicity <new-remote-name> C-master --squash
+```
+
+- Run build and tests.
+
+- Create a new PR to Elements.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.