Mark/esolang
1
0
Fork 0
Code Issues Packages Activity

Add developer notes to the language README files

Browse Source
This commit is contained in:
Nilay Majorwar
2022-02-18 20:50:53 +05:30
parent 5b5600f329
commit 41b553737a
6 changed files with 112 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
scripts/new-lang-template/README.md
View File

@ -1,5 +1,20 @@
# $LANG_NAME
## References
Add a short summary about the language, including link(s) to the language specification and sample programs.
## Notes for the user
- Add details and quirks (if any) about the Esolang Park implementation of this esolang.
- These are details that the user may want to know while executing or debugging programs on the editor.
## Implementation details
- Add notes that a contributor may want to read while looking at the source code of the language provider.
- This includes any third-party libraries you've used, something you've done for performance, or just the
main decisions you took while implementing the language provider.
- If the source code is simple enough, you can simply omit this section.
## Possible improvements
- Add any bugs or suboptimalities in the language provider that a contributor can work on.
- (this section doesn't mean you can add a half-baked interpreter and leave, though.)