search

HoerTech-gGmbH / openMHA

The open Master Hearing Aid (openMHA)
http://www.openmha.org
GNU Affero General Public License v3.0
252 stars 74 forks source link

Change file extension of reference_algorithms/README #59

Closed digitalfrost closed 1 year ago

digitalfrost commented 2 years ago

README file was written in markdown but had a .txt file extension. Changed to .md extension

tobiasherzke commented 2 years ago

Thanks for the suggestion. This file may be referenced elsewhere by the .txt filename. Maybe we can find the places where it is referenced like this:

$ grep -r reference_algorithms . | grep -v ./.git/ | cut -d: -f1 | sort -u | xargs grep -n README
./README.md:40:list of publications at the end of this README.
./README.md:72:Please refer to files README_NALNL2.md and README_DSLmio5.md for more
./README.md:107:For references and more information see README.txt in the
./mha/tools/packaging/exe/mha.nsi:47:File /oname=README.txt "..\..\..\..\README.md"
./mha/tools/packaging/exe/mha.nsi:93:  CreateShortCut "$SMPROGRAMS\${PRODUCT_NAME}\Readme.lnk" "$INSTDIR\README.txt"
./mha/tools/packaging/exe/mha.nsi:111:  Delete $INSTDIR\README.txt

Hendrik can you decide if we want this name change? If we want, then we need to investigate if these locations refer to the file and see if they need changes too. Just from this results list I think the 3rd and 4th result are most likely referring to this file, and it looks like the 4th is already doing this renaming for the Windows installer (but I'm not sure if this is how nsi works).

We may also need a more thorough search method.

hendrikkayser commented 1 year ago

Let's use the .md extension for the README.