You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Pjotr Prins ec78eabfbd Removing CRAM support 11 months ago
..
.gitignore Man page for mpileup 7 years ago
README.md Documentation guide for developers 5 years ago
sambamba-flagstat.1 Man files: added references 7 years ago
sambamba-flagstat.1.ronn fixed a bug in markdup; updated docs 8 years ago
sambamba-index.1 fix formatting 5 years ago
sambamba-index.1.ronn fix formatting 5 years ago
sambamba-markdup.1 Man files: added references 7 years ago
sambamba-markdup.1.ronn Man files: added references 7 years ago
sambamba-merge.1 Man files: added references 7 years ago
sambamba-merge.1.ronn Man files: added references 7 years ago
sambamba-pileup.1 Man files: added references 7 years ago
sambamba-pileup.1.ronn mpileup: updated man pages 7 years ago
sambamba-slice.1 Man files: added references 7 years ago
sambamba-slice.1.ronn fixed a bug in markdup; updated docs 8 years ago
sambamba-sort.1 Man files: added references 7 years ago
sambamba-sort.1.ronn Man files: added references 7 years ago
sambamba-view.1 Removing CRAM support 11 months ago
sambamba-view.1.ronn Removing CRAM support 11 months ago
sambamba.1 Removing CRAM support 11 months ago
sambamba.1.ronn Removing CRAM support 11 months ago

README.md

Guide for developers

Ronn

All documentation is written in Markdown format with .ronn extension.

Ronn is a generator that can produce both man pages and HTML snippets. You can install it as a Ruby gem or through your package manager (ruby-ronn on Ubuntu).

During editing, it's very helpful to check that output looks as intended; this is done by running ronn -m <filename.ronn> which will launch the man pager.

Generated files

  • Man pages, generated by ronn -r, currently go here, alongside .ronn files.
  • HTML snippets are generated by ronn -f and go into gh-pages branch. The branch should be cloned to a separate directory on your machine, and the destination for the snippets (.html_fragment extension) is the _includes directory.