search

MEGA65 / mega65-fdisk

FDISK+Format Utility for MEGA65
GNU General Public License v3.0
12 stars 8 forks source link

Create a README.txt file along with system files from the core #18

Open dansanderson opened 1 year ago

dansanderson commented 1 year ago

Is your feature request related to a problem? Please describe. Users need more opportunities to learn about SD card management. For example:

  1. The purposes of the files installed by the SD card utility
  2. Where to download bundled software (GEOS, etc.) and updates
  3. Why and how to format the card with the MEGA65 SD card utility
  4. How to work around issues with incomplete FAT32 support (fragmentation), using mega65_ftp/etherload
  5. Tips for dealing with spurious files installed by the host OS (especially macOS) or long filenames

Describe the solution you'd like Create a plaintext document named README.txt containing this information. Embed it in the core as one of the files it populates via the SD card utility. Include it in the bundled SD card image.

Describe alternatives you've considered Alternatively, the README.txt file could be a short file with a reference to a chapter in the manual, or a mega65.org short URL that redirects to a Filehost or Wiki article. The goal is to present the user with this information at the point it is useful, i.e. when they mount the SD card on their PC. A user will probably follow a link found in this file.

lydon42 commented 1 year ago

I think your proposal stems from a wrong interpretation of one remark I made.

I don't think this is needed, I vote against it. We have documentation about all of this, that can be read.

Adding more TEXT to a utility that is store in the COLORRAM is bad, as we rob us the space for utilities or functions that are really needed.

gurcei commented 1 year ago

Maybe I missed the past remark being referred to, but when I see Dan's perspective on this matter in isolation from any past convo it was spawned from, I feel it does have its merits.

For me, I do like the idea of a readme.txt on the sd-card as an avenue to educate the user about sd-card related matters. Sure, we may have may other sources with such details (pdf docs, filehost articles, wiki pages), though I feel like the readme.txt on the sd-card has the advantage of providing those specific details in the user's current mental context. E.g., user is interested in sniffing what's on the sd-card, pondering what they could add to it, or thinking how to go about formatting another sd-card for the external micro-sd slot with similar contents.

As for level of detail within the readme.txt, I'd be interested to see what Dan comes up with, what level of detail/verbosity he feels would work, or whether just hinting at these matters and providing links to other more verbose resources would do.