prisms-center / phaseField

PRISMS-PF: An Open-Source Phase-Field Modeling Framework
https://prisms-center.github.io/phaseField/
Other
229 stars 119 forks source link

Consider switching in-code app documentation from LaTeX to Markdown #189

Open stvdwtt opened 1 year ago

stvdwtt commented 1 year ago

GitHub now supports equations in Markdown. The process of editing documentation might be easier if all of the apps have their documentation in Markdown instead of LaTeX, since GitHub will directly render the code and no one has to build a pdf with LaTeX. It'd take a little time to do the switch, but would probably only be ~1 day of work.

@david-montiel-t what do you think?

david-montiel-t commented 1 year ago

I think this is a good idea. There is summer student who might be able to work on this.