organisation icon indicating copy to clipboard operation
organisation copied to clipboard

Published 20 hours ago • verified publisher icon apertium

All Readme's should link to wiki

Open TinoDidriksen opened this issue 7 years ago • 3 comments

As https://github.com/apertium/apertium-kir/issues/1 noted, the various individual READMEs do not tell how to install the various core tools. All READMEs should link to http://wiki.apertium.org/wiki/Installation at least.

TinoDidriksen avatar Sep 13 '18 10:09 TinoDidriksen

Is apertium-init's README good? I think that's the most important change to make because changing existing READMEs is something that could take forever to actually happen.

sushain97 avatar Sep 13 '18 17:09 sushain97

I'd say no. It says to check www.apertium.org where you then have to click Download then Installation. Two extra clicks, where the first is not that obvious.

As for batch updating all READMEs, that's mostly scriptable.

TinoDidriksen avatar Sep 13 '18 17:09 TinoDidriksen

The README in apertium-bre is pretty ok. If any changes are made they should be propagated there too.

ftyers avatar Sep 13 '18 19:09 ftyers