search

qmarcou / IGoR

IGoR is a C++ software designed to infer V(D)J recombination related processes from sequencing data. Find full documentation at:
https://qmarcou.github.io/IGoR/
GNU General Public License v3.0
47 stars 25 forks source link

Create required README.md as part of autogen.sh #11

Closed NickEngland closed 6 years ago

NickEngland commented 6 years ago

This fixes my issue #10

NickEngland commented 6 years ago

That is indeed a more sensible way to do things, I haven't used asciidoc before so I was taking the smallest change to get it working :) If asciidoc can make the man file directly, that makes a lot more sense. I'll do a pull request with just the +x for dev.

If I try to do asciidoc to manpage directly, I get the following: asciidoc -d manpage README.adoc asciidoc: FAILED: README.adoc: line 4: manpage document title is mandatory

What command are you using to generate the manpage from the asciidoc?

qmarcou commented 6 years ago

I think you have the correct command to do it but the manpage asciidoc document seems to need more structure than the README one. I think the best way to handle this is to create separate files for manpage and README (which was the whole point of breaking the doc in several files in a first place). I'll take care of this very soon, in the meantime you can use your proposed solution locally to compile IGoR

qmarcou commented 6 years ago

The issue has been fixed on dev branch and will be released in the release following 1.2.0