colinsheppard / pevi

GNU General Public License v3.0
1 stars 0 forks source link

convert model description to markdown #13

Open colinsheppard opened 11 years ago

colinsheppard commented 11 years ago

I'd like to add the model description to the repository so we can collaborate on it as if it were code (especially using the issue tracker). This will make it easier to maintain different versions of the document for different versions of the model (Humboldt / Upstate / Delhi / etc).

To do this I don't want it in word format, rather let's collaborate on it in markdown format. So the first step will be to convert the existing document into markdown. See the github markdown readme to get started. There are tons of other references on markdown online.

When we need outside feedback, we'll convert from the markdown version to word using "pandoc". See this issue for the skinny on installing pandoc.

Then we'll incorporate feedback back into the markdown document. It's a pain, but I since you and I will do most of the editing, I think the benefits of textual manipulations outweigh incorporating outside feedback.

colinsheppard commented 11 years ago

need to deal with missing equations and some mis-formatted tables.

also, let's rename to PEVI-model-description.md and put it along with the graphics underneath a single folder called model-description.

arharris commented 11 years ago

Final issues before closing thread: equations have different form from markdown to pandoc; write command line tool to switch on pandoc mode. This means all equations must be entered twice: once in commented-out pandoc, and once in GFM.

Tables will be edited manually before pushing through pandoc.

colinsheppard commented 11 years ago

something to look into:

https://github.com/somu/gutenberg