search

phac-nml / neptune

Neptune: Genomic Signature Discovery
https://phac-nml.github.io/neptune/
Apache License 2.0
18 stars 7 forks source link

Add link to Manual.pdf to README.md #2

Closed tseemann closed 7 years ago

tseemann commented 7 years ago

Eric,

It took me a while to figure out that the documentation was in a Latex PDF here:

https://github.com/phac-nml/neptune/blob/release/1.2/documentation/manual/Manual.pdf

Can you link to it from README.md or even better somehow get it in Markdown format?

Torst

fbristow commented 7 years ago

Hi Eric,

If you're planning to re-write your docs in Markdown (or whatever) instead of just linking to your latex document, you can try using pandoc to get started. That should make it a lot easier to translate between latex and Markdown (or whatever).

emarinier commented 7 years ago

I've made simple Markdown links in the README that direct to the manual. I'm planning a patch release in the very near future to help clarify the manual. The documentation being linked to will be the PDF manual, not the Latex document.

There are currently no plans to rewrite the documentation in another format. However, this might change in the future.

emarinier commented 7 years ago

I've added simple Markdown links in the README that link directly to the PDF manual. This should help direct users to the documentation.

Release: 1.2.4 Merge: 48b1ab5f06ad8dd1f92fb5aec9d136c9326bc553

emarinier commented 7 years ago

Actually, I've changed my mind after reading:

http://hdl.handle.net/1807/73111

and converted the documentation into a website hosted on GitHub Pages:

https://phac-nml.github.io/neptune/

I'm working on polishing everything up now.