Apple-2gs-SW
/
md2teach
mirror of https://github.com/jeremysrand/md2teach.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update the project readme to point to the distribution readme.

This commit is contained in:
Jeremy Rand 2021-06-30 00:27:08 -04:00
parent 345a1bb88b
commit 573f12bbaf
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -5,3 +5,6 @@ This repository is work-in-progress to try to use [md4c](https://github.com/mity
The goal really is to use this shell command from GoldenGate as part of my [Apple2GSBuildPipeline](https://github.com/jeremysrand/Apple2GSBuildPipeline) in order to write documentation for GS projects in a more modern file format. Also, markdown is trivial to commit to git repositories but the presence of the resource fork in Teach files make them problematic.
The files md4c.c and md4c.h are (hopefully) slightly modified versions of the files from the md4c project. It is shocking how portable that code was and it worked almost immediately. I am marking up some of my changes with the comment tag GS_SPECIFIC. In general, many unsigned types were converted to uint32_t and int types converted to int32_t.
For more information, review the [md2teach Readme from the SW distribution](/md2teach/Read.Me.md).