search

FujiNetWIFI / fujinet-config-tools

Atari side programs for configuring FujiNet
10 stars 12 forks source link

Idea for changing how docs are maintained #11

Open billkendrick opened 3 years ago

billkendrick commented 3 years ago

I was confused/surprised that dist-doc is in Github when it's generated, based on what's in doc. The Makefile simply seems to copy them, en-masse, from one directory to the other. Is there a reason this is done?

It's also a little tedious to create or edit the doc files on a non-Atari (e.g., vi on Linux), since the EOL characters are Atari specific. I'm thinking we can use modern EOL in the doc files, and then simply translate them as part of the copying process.

i.e., rather than the (more-or-less) cp doc/* dist-doc/ that's in Makefile now, use tr '\233' '\n' < doc/FILE.DOC > dist-doc/FILE.DOC or somesuch...?

billkendrick commented 3 years ago

Having the DOCs in something GitHub understands (and doesn't assume is just "binary file") would also make diff'ing easier :)