Skip to content

Commit d45e1c9

Browse files
authored
Revise README for HERESY v1.0.0 and citations
Updated the README to reflect the new versioning and added citation information.
1 parent 3818657 commit d45e1c9

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
# 🐍 HERESY β€” C inside Rust inside C (v1.0.0)
1+
# 🐍 HERESY v1.0.0 β€” C-in-Rust, Rust-in-C, Makefiles in Tears
2+
3+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
4+
[![CI: Passed (Sanity Failed)](https://img.shields.io/badge/CI-passed_(sanity_failed)-red.svg)](https://github.com/QSOLKCB/HERESY/actions)
5+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17588734.svg)](https://doi.org/10.5281/zenodo.17588734)
6+
[![Status: Unholy](https://img.shields.io/badge/status-unholy-black.svg)](#)
7+
[![Build: Recursive](https://img.shields.io/badge/build-ouroboros-8e44ad.svg)](#)
8+
9+
> *"Because one build system was never enough."*
10+
> β€” QSOL-IMC, Department of Recursive Theology
211
312
**A complete C program embedded as a raw string in Rust that writes/compiles/links its own C mini-project.**
413
Rust spawns a C generator, the C generator emits `alpha.c`, `beta.c`, `runner.c`, builds `heresy_exe`, and (optionally) tries to poke Cargo again. Recursion guard included.
@@ -59,3 +68,20 @@ CI keeps the recursion guard on.
5968
Glory Wall
6069
β€œI compiled a compiler that compiles a compiler that compiles my alibi.” β€” A responsible engineer, allegedly
6170

71+
πŸ“œ Citation
72+
73+
If you cite this, you accept moral responsibility for the recursion.
74+
75+
@software{slade_heresy_2025,
76+
author = {Trent Slade},
77+
title = {{HERESY v1.0.0 β€” C-in-Rust, Rust-in-C, Makefiles in Tears}},
78+
month = nov,
79+
year = 2025,
80+
publisher = {Zenodo},
81+
version = {1.0.0},
82+
doi = {10.5281/zenodo.17588734},
83+
url = {https://zenodo.org/records/17588734}
84+
}
85+
86+
87+
β€œMay future archaeologists wonder why.”

0 commit comments

Comments
Β (0)