markus-zzz / myc64-pocket

A Commodore 64 core for the Analogue Pocket
32 stars 2 forks source link

Populate the wiki #10

Open markus-zzz opened 5 months ago

markus-zzz commented 5 months ago

Populate the wiki with useful information on how to get started, solve common problems etc.

markus-zzz commented 5 months ago

[Original post by lunchpacked130 in #7 moved to appropriate issue. I am trying to organize the issue tracking a bit so I copy&pasted it here. Maybe there is a better way but I'm not aware..]

@markus-zzz :

@lunchpacked130, that stuff could serve as a nice getting started guide if you add it to the wiki. Maybe also add some screen dumps from the pocket of the different menus.

I gave it a shot 😅 it's still work in progress, and i want to change the photos with new ones.. for one, the buttons doesn't really show that good on my translucent red pocket, and I'd also like to get proper screenshots of the openfpga menu, as now its just a photo, and there's an unessesary white border edge that should be cropped etc.

I'm fairly new to contributing on github, so i hope it's not a complete mess 🙈 and though I've written a couple of guides for work related training etc, it might come off as a bit "hand holding" or overkill 😅

I try to make it understandable and accessible for both experts and those who are completely new, (even that one user who you have to hold their hand and slowly guide them through each step, answering fun questions like "why should i not press no when it asks me to install, what if its a virus" etc. And in the end never learns anything and has to constantly check the guide for how to do it) (If you've worked in IT or computer support services, you know the type)

So i typically find it's better to explain one thing too many than too little.

I'm not sure if the guide is how you were wanting it to be, but i hope I'm not way off :p or since I'm not really that familiar with contributing on github, that i have submitted it the wrong way or if i should have made an entry somewhere with "to do's" and assignments etc so others editing can see what needs to be done etc, or something similar like that.. But I'm pretty sure that continuing this in a "issue" isn't the best way to do it 😅

but anyway, I'd appreciate any constructive feedback you can give me :)

@dukestah

I'd like to provide some help if needed.

That's very much appreciated :) If you have a dock and keyboard, you can help with that section as i don't have the dock myself. And also if you find something I've missed or is incorrect or have an idea etc. Feel free to fix/add it.

If by chance you guys like how I wrote the guide/how it looks, i can edit the wiki and make it as consistent as possible to the rest of the guide, provided you can contribute your findings/information about using the dock/ext. Keyb. And maybe take some photos/screenshots for me. I will of course give you credit (if you want it) just again, I'm new to this whole github thing, so I'm not sure if there's a built-in way to do it 😅 so you could also help me with that and/or other "github things" if you want :)

markus-zzz commented 5 months ago

I think this is good! Since the intention is to help users it is much better to have too much detail than too little. I really have my hands full with tons of other stuff it feels like so this is a much appreciated to get some help with documentation (which I am not very good at anyway).

I would update the disclaimer about crunched to something like the following to be more accurate (of what I meant to convey earlier) but otherwise it is good. Please carry on :+1:

[!CAUTION] If the game starts immediately on step 8 that would be an indication that the .prg file is replacing the entire contents of system RAM and that is not supported. In general .prg files don't do that but the un-crunched ones in OneLoad64-Games-Collection-v5.7z do so make sure to use the crunched ones from the AlternativeFormats/PRGs/Crunched/ subdirectory of that archive. Even if the game seems to start fine, you can get glitches/errors in sound and graphics, and the game can spontaneously crash.