Add basic meta documentation #11

Merged
ShatteredMINT merged 13 commits from meta-documentation into main 2026-09-02 11:39:26 +02:00
Showing only changes of commit f2e5c830b3 - Show all commits
+2 -2
View File
@@ -11,7 +11,7 @@ Be nice, we are all just doing this to have fun
## Documenting Functions
All functions in the standard library should follow the following outline:
```asm
```
; <description>
; Arguments: <which register contains what argument>
; Result: <what is the result, and where is it stored>
@@ -22,4 +22,4 @@ fn_label: <;SHOULD BE INLINED>
```
Functions should be in the appropriate asm file, if you are unsure where functionality fits make a seperate file and ask in the pull request
Functions that are provided for convenience/reference but should be inlined in production code should be marked with `;SHOULD BE INLINED` after their label