search

djhackersdev / bemanitools

Runs recent Konami arcade games and emulates various arcade hardware.
The Unlicense
84 stars 16 forks source link

Consolidate iidxhook doc files into a single one #79

Open icex2 opened 3 years ago

icex2 commented 3 years ago

Summary

Merge the various iidxhookX.md files into a single one.

Detailed description

There is a lot of copy-pasting going on making this tedious to maintain. I just eye-balled this and it looks like most of the information is overalapping anyway. I think the overall maintainability and readability for the user can be improved if we just create a single iidxhook.md and clarify the 2-3 different paths, e.g. for setup, in there.

Benefits

Better maintainability for contributors and readability for the user.

Drawbacks

Hopefully none, but one has to check if the outcome is actually better in regards of the outlined benefits.

Current blockers

None

icex2 commented 3 years ago

In GitLab by @Corin on May 2, 2021, 14:33

I feel there should definitely be a iidxhook.md that all iidxhookX.md's should reference but I think merging them all into one is a bit excessive, for example: iidxhook9 has specific stuff relating to the OS iidxhook1-3 has specific stuff relating to the sidcode etc

Perhaps keeping the per-hook files would be a better idea with the more generalised parts linking back as a "please see x in iidxhook.md" or something?

icex2 commented 3 years ago

That might be a good hybrid, I agree.

In general, once someone picks this up, they have to just protoype, move things around and see what makes sense and works best. I found it already quite difficult to anticipate just by looking at the files and their content.

icex2 commented 3 years ago

In GitLab by @Corin on May 2, 2021, 14:47

Agreed, it might be worth waiting for !94 to be merged in before visting this issue tbh