mirror of https://github.com/jeremysrand/md2teach.git synced 2024-12-21 02:29:25 +00:00

A markdown to teach text converter ORCA shell command for the GS based on md4c.

Go to file

Jeremy Rand 34fd580448 Implement the rest of the direct writing of resources to the file. I have tested this under GNO (as opposed to Golden Gate where resource writes are not yet supported) and it does seem to work. I also tested it at 2.8MHz and the large test file takes about 30 seconds to convert. I may look at turning on the optimizer in the compiler to try to get a bit better performance on real HW. I decreased the stack size to 8K for now because 32K was too big for a "real" machine as opposed to the emulated Golden Gate.		2021-05-05 00:23:28 -04:00
md2teach	Implement the rest of the direct writing of resources to the file. I have tested this under GNO (as opposed to Golden Gate where resource writes are not yet supported) and it does seem to work. I also tested it at 2.8MHz and the large test file takes about 30 seconds to convert. I may look at turning on the optimizer in the compiler to try to get a bit better performance on real HW. I decreased the stack size to 8K for now because 32K was too big for a "real" machine as opposed to the emulated Golden Gate.	2021-05-05 00:23:28 -04:00
md2teach.xcodeproj	Implement a workaround for writing resources. Write the resources I want to a .rez file and use a script in the build itself to turn that into resources and attach it to the output file. This seems to result in a styled teach file for my test input that loads and looks pretty close to right.	2021-04-29 00:24:27 -04:00
LICENSE	Add a readme and license file.	2021-04-13 23:53:20 -04:00
README.md	Review all uses of int and unsigned and promote them to int32_t or uint32_t as required.	2021-04-16 00:26:25 -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.