search

keirf / greaseweazle

Tools for accessing a floppy drive at the raw flux level
The Unlicense
993 stars 100 forks source link

Proposal for slightly more elaborate documentation #395

Closed Yserra closed 8 months ago

Yserra commented 10 months ago

Hi Keir, I wish you an happy new year.

Since I find this page https://github.com/keirf/greaseweazle/wiki/Getting-Started a bit frustrating, I've tried to write a little more comprehensive documentation. See the attachment.

Feel free to take from it as much as you like.

Please note: English is not my mother tongue (I'm French) and this text may contain language errors.

Hope it could be useful.

Best. GreaseweazleDoc.zip

keirf commented 10 months ago

Wow, that's a lot better!

keirf commented 10 months ago

Since it's baked html, I will probably need to copy text out of a web browser and fix up for GitHub markdown?

Yserra commented 10 months ago

I have no idea. Actually, I wrote this with Microsoft Word and saved it as .html. I tried to convert the .docx to .md with Pandoc, but it was a bit of a mess (the tables, the images went away, the font was non-sense). Would you have any recommandation to share that would help me produce the format you are expecting?

here is the docx document, by the way: GreaseweazleDocumentation.docx

ps: I'm happy your appreciated it :)

keirf commented 10 months ago

Thanks. I can do a lot more with the docx original file. For example pandoc produces halfway sensible Markdown which I can tweak.

keirf commented 10 months ago

See what you think of the new Getting Started wiki page! https://github.com/keirf/greaseweazle/wiki/Getting-Started

keirf commented 10 months ago

Images currently missing. To be added :)

Yserra commented 10 months ago

Thank you Keir, It's fantastic! I'm honored to be part of this great adventure :)