X16Community / x16-docs

Commander X16 Documentation (CC BY-SA)
95 stars 34 forks source link

document the CBM kernal routines #83

Open irmen opened 1 year ago

irmen commented 1 year ago

Documentation for several kernal routines is missing / incomplete.

This issue is for the CBM kernal routines that the X16 inherited from the CBM/C64 kernal rom. These are documented elsewhere on the internet, but should be documented here as well.

Note that the Floating Point routines are excluded from this as well, they already have their own page.

irmen commented 1 year ago

What do we consider "good" existing reference material for the CBM kernal routines? Personally I have a couple of bookmarks I return to all the time:

http://sta.c64.org/cbmdocs.html, most notably http://sta.c64.org/cbm64krnfunc.html https://c64os.com/post/c64kernalrom pretty good writeup with explanations https://www.pagetable.com/c64ref/kernal/

Here's some more, courtesy of @JimmyDansbo : https://www1.cx16.dk/c64-kernal-routines/ https://www1.cx16.dk/c128-kernal-routines/

Maybe less useful on the x16: https://www.pagetable.com/c64ref/c64disasm/
https://project64.c64.org/Software/mapc6411.txt

m00dawg commented 1 year ago

Is it just referring to kernel calls or in general? It's a bit discounted but I like:

http://6502.org/tutorials/6502opcodes.html http://www.6502.org/tutorials/65c02opcodes.html

Also I've volunteered to take that 2nd bullet point.

irmen commented 1 year ago

Just the kernal calls for now, other types of documentation or changes should get its own issue IMO (including the FP routines which already have their own separate chapter)

m00dawg commented 1 year ago

Started work on task 2 via this PR: https://github.com/X16Community/x16-docs/pull/84/files

pacav69 commented 1 year ago

I think for begginers, there should be the creation of examples of code using the kernal routines to further improve the teaching and learning of the 6502 assembler coding. This would be useful for the education sector in promoting future computer programmers.

irmen commented 1 year ago

Sure, examples and tutorials are needed too, but this item is only about reference documentation. Let's talk about other kinds of documentation elsewhere.

irmen commented 1 year ago

I'll update the task list soon as some work has been done :)