Apple-2gs-SW/md2teach
1
0
Fork 0
mirror of https://github.com/jeremysrand/md2teach.git synced 2024-12-21 17:30:50 +00:00
Code Issues Projects Releases Wiki Activity
A markdown to teach text converter ORCA shell command for the GS based on md4c.
39 Commits 1 Branch 1 Tag 1.9 MiB
C 90.9%
Makefile 5.3%
Shell 3.8%
main
Go to file
Jeremy Rand 573f12bbaf Update the project readme to point to the distribution readme.
2021-06-30 00:27:08 -04:00
md2teach Final commit before publishing version 1.0. 2021-06-30 00:21:59 -04:00
md2teach.xcodeproj Add a Read.Me.md file which will be used to document the shell command for the distribution. For now, it is just a skeleton. Use md2teach to convert that markdown file into a Teach file for the distribution. Make running the test.md file through md2teach optional based on a DEBUGBUILD setting in the Makefile. 2021-06-23 00:09:38 -04:00
LICENSE Add a readme and license file. 2021-04-13 23:53:20 -04:00
README.md Update the project readme to point to the distribution readme. 2021-06-30 00:27:08 -04:00

README.md

md2teach

This repository is work-in-progress to try to use md4c to create a markdown to Teach text converter ORCA shell program for the Apple //GS. You should not try to use this tool because it doesn't work yet.

The goal really is to use this shell command from GoldenGate as part of my 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.