aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..db8461f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Clean RTS Cheat Sheets [![pipeline status](https://gitlab.science.ru.nl/cstaps/clean-rts-cheat-sheet/badges/master/pipeline.svg)](https://gitlab.science.ru.nl/cstaps/clean-rts-cheat-sheet/commits/master)
+
+This repository holds cheat sheets for people hacking around with the [Clean][]
+run-time system. The latest set of cheat sheets can be downloaded [here][pdf],
+or you can clone the repository and run `pdflatex` on the file corresponding to
+your platform.
+
+## Naming conventions
+
+- **asp**: A-stack pointer
+- **bsp**: B-stack pointer
+- **hp**: heap pointer
+- **free**: counter of free words on heap
+- **scr**: scratch register
+
+[Clean]: http://clean.cs.ru.nl
+[pdf]: https://gitlab.science.ru.nl/cstaps/clean-rts-cheat-sheet/-/jobs/artifacts/master/download?job=pdf