sandialabs / TChem

TChem - A Software Toolkit for the Analysis of Complex Kinetic Models
BSD 2-Clause "Simplified" License
54 stars 21 forks source link

Readme conversion for latex #1

Closed kyungjoo-kim closed 3 years ago

kyungjoo-kim commented 3 years ago

It needs to preprocess readme with latex. To avoid confusion with code environment ${TCHEM_BLAH}, replace the dollar symbol with another one. If the math equation is multi-line within $ $, make it a single line (readme2tex does not understand this). When $$ $$ is used, give a new line at the end. Otherwise, format becomes werid. Then run the markdown with readme2tex.

Then, change svgs path to relative path.