README.md

NGB documentation

NGB documentation is provided in a markdown format, that could be viewed directly from github or could be built into html representation

Documentation index

The following sections are currently covered in a documentation

• Installation guide
  • Overview
  • Using Docker
  • Using Binaries
  • Using Standalone Jar
• Command Line Interface guide
  • Overview
  • CLI Installation
  • Running a command
  • Accomplishing typical tasks
  • Command reference
• User Interface Guide
  • Overview
  • Working with datasets
  • Working with tracks
  • Reference track
  • Genes track
  • VCF track
  • WIG track
  • BED track
  • Aignments track
  • Working with Annotations

Building documentation

MkDocs and epam-material theme (based on mkdocs-material) are used to build documentation into html representation

So make sure that both dependencies are installed according to the installation guide

Once installed, obtain markdown sources from github

$ git clone https://github.com/epam/NGB.git
$ cd NGB/docs

Run build

$ mkdocs build

This will create site/ folder, containing built html documentation

To view documentation - navigate in ngb/docs/site/ folder and launch index.html with a web-browser