search

brettc / partitionfinder

PartitionFinder discovers optimal partitioning schemes for DNA sequences.
Other
60 stars 42 forks source link

Manual in md? #113

Closed alephreish closed 7 years ago

alephreish commented 8 years ago

It'd be better IMHO to have the manual as a markdown file (and/or wiki?) instead of Word's docx. This would provide the following benefits:

brettc commented 8 years ago

I agree (I had even looked at converting it at some stage). But the main author of the manual doesn't use markdown. Pull requests welcome!

alephreish commented 8 years ago

Let's see. Pandoc seems to do the job pretty satisfactorily, although a bit of polishing is required afterwards.

roblanf commented 8 years ago

I would be very open to a bit of help with a MD manual. We are on the verge of releasing PF2, so a proper change would be timely too.

Bear in mind that most users of the package are biologists with little or no experience of using the command line. But as long as there's a PDF of the manual in /docs, I think we have those folks covered.

On 18 July 2016 at 07:51, Andrey Rozenberg notifications@github.com wrote:

Let's see. Pandoc seems to do the job pretty satisfactorily, although a bit of polishing is required afterwards.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/brettc/partitionfinder/issues/113#issuecomment-233206320, or mute the thread https://github.com/notifications/unsubscribe-auth/AA2pE-GtEoYY3WPa7pgo9R6gkwadN7DCks5qWqPggaJpZM4JOMTt .

Rob Lanfear School of Biological Sciences, Macquarie University, Sydney

phone: +61 (0)2 9850 8204

www.robertlanfear.com

brettc commented 8 years ago

Pandoc was what I toyed with -- it is a great tool.

roblanf commented 7 years ago

I'm closing this, since nobody did it. I think keeping the manual as a PDF is just fine.

alephreish commented 7 years ago

I'm (still) quiet a bit busy with my PhD thesis, but once I have some time, I'll come back.