diff --git a/README.md b/README.md index 8169ac2..b49e929 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,33 @@ So: So that is what this project is: a sourcefile containing what seems some oddly but still acceptable formatted text that compiles to the quine. +# How to run + +Run `build.sh` with the mblf compiler installed. +The mblf compiler needs to be installed from [source](https://github.com/MBLF-Project/mblf/releases/tag/v0.1.0), as it needs the **AllArged patch**. + +## Installing mblf from source with AllArged patch + +```sh +git clone https://github.com/MBLF-Project/quine-stuff.git +git clone https://github.com/MBLF-Project/mblf.git + +cp quine-stuff/patches/AllArged.diff mblf/ +cd mblf + +git checkout tags/v0.1.0 +git apply AllArged.diff +rm AllArged.diff + +cargo install --path . + +``` + +## Generate quine + +```sh +cd ../quine-stuff +./build.sh +``` + +If all steps went correctly, you should have the file quine.bf, which was generated from the wordFactList.mblf