From 114938f72e8b6a3a5ad340a1e1af9436b06bd258 Mon Sep 17 00:00:00 2001
From: Jacques Dainat <jacques.dainat@gmail.com>
Date: Wed, 7 Jun 2023 11:19:57 +0200
Subject: [PATCH 1/2] add badges in readme

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 8eab3df..bb70a11 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
 [![Build Status](https://travis-ci.org/lh3/minigraph.svg?branch=master)](https://travis-ci.org/lh3/minigraph)
+[![BioConda Install](https://img.shields.io/conda/dn/bioconda/minigraph.svg?style=flag&label=BioConda%20install)](https://anaconda.org/bioconda/minigraph)
+[<img alt="docker_minigrapht" src="https://img.shields.io/badge/container-Docker-blue">](https://quay.io/repository/biocontainers/minigraph)
+[<img alt="singularity_minigraph" src="https://img.shields.io/badge/container-Singularity-orange">](https://quay.io/repository/biocontainers/minigraph)
+[![Anaconda-Server Badge](https://anaconda.org/bioconda/minigraph/badges/license.svg)](https://anaconda.org/bioconda/minigraph)
+
 ## <a name="started"></a>Getting Started
 
 ```sh

From c1e1c2754f37189c76b7ca4e0bfdb606ba0da6d8 Mon Sep 17 00:00:00 2001
From: Jacques Dainat <jacques.dainat@gmail.com>
Date: Wed, 7 Jun 2023 11:44:25 +0200
Subject: [PATCH 2/2] Update README.md

Add also doc link via badge. Be careful the status does not reflect the real GitHub actions / deployment status
---
 README.md | 46 +++++++++++++++++++++++++++++-----------------
 1 file changed, 29 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index bb70a11..f90d8e3 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,52 @@
 [![Build Status](https://travis-ci.org/lh3/minigraph.svg?branch=master)](https://travis-ci.org/lh3/minigraph)
+[![Documentation Status](https://img.shields.io/badge/doc-passing-brightgreen)](https://lh3.github.io/minigraph/)
 [![BioConda Install](https://img.shields.io/conda/dn/bioconda/minigraph.svg?style=flag&label=BioConda%20install)](https://anaconda.org/bioconda/minigraph)
 [<img alt="docker_minigrapht" src="https://img.shields.io/badge/container-Docker-blue">](https://quay.io/repository/biocontainers/minigraph)
 [<img alt="singularity_minigraph" src="https://img.shields.io/badge/container-Singularity-orange">](https://quay.io/repository/biocontainers/minigraph)
 [![Anaconda-Server Badge](https://anaconda.org/bioconda/minigraph/badges/license.svg)](https://anaconda.org/bioconda/minigraph)
 
+minigraph
+=========================================
+
+Seq-to-graph mapper and graph generator
+
+## Table of Contents
+
+<img align="right" width="278" src="doc/example1.png"/>
+
+- [Getting Started](#started)
+- [Introduction](#intro)
+- [Users' Guide](#uguide)
+  - [Installation](#install)
+  - [Sequence-to-graph mapping](#map)
+  - [Graph generation](#ggen)
+  - [Calling structural variations](#callsv)
+  - [Prebuilt graphs](#prebuilt)
+  - [Algorithm overview](#algo)
+- [Limitations](#limit)
+
 ## <a name="started"></a>Getting Started
 
 ```sh
-git clone https://github.com/lh3/minigraph
-cd minigraph && make
 # Map sequence to sequence, similar to minimap2 without base alignment
 ./minigraph test/MT-human.fa test/MT-orangA.fa > out.paf
+
 # Map sequence to graph
 ./minigraph test/MT.gfa test/MT-orangA.fa > out.gaf
+
 # Incremental graph generation (-l10k necessary for this toy example)
 ./minigraph -cxggs -l10k test/MT.gfa test/MT-chimp.fa test/MT-orangA.fa > out.gfa
+
 # Call per-sample path in each bubble/variation (-c not needed for this)
 ./minigraph -xasm -l10k --call test/MT.gfa test/MT-orangA.fa > orangA.call.bed
 
 # The lossy FASTA representation (requring https://github.com/lh3/gfatools)
 gfatools gfa2fa -s out.gfa > out.fa
+
 # Extract localized structural variations
 gfatools bubble out.gfa > SV.bed
 ```
 
-## Table of Contents
-
-<img align="right" width="278" src="doc/example1.png"/>
-
-- [Getting Started](#started)
-- [Introduction](#intro)
-- [Users' Guide](#uguide)
-  - [Installation](#install)
-  - [Sequence-to-graph mapping](#map)
-  - [Graph generation](#ggen)
-  - [Calling structural variations](#callsv)
-  - [Prebuilt graphs](#prebuilt)
-  - [Algorithm overview](#algo)
-- [Limitations](#limit)
-
 ## <a name="intro"></a>Introduction
 
 Minigraph is a sequence-to-graph mapper and graph constructor. For graph
@@ -60,6 +68,10 @@ To install minigraph, type `make` in the source code directory. The only
 non-standard dependency is [zlib][zlib]. For better performance, it is
 recommended to compile with recent compliers.
 
+```sh
+git clone https://github.com/lh3/minigraph
+cd minigraph && make
+```
 ### <a name="map"></a>Sequence-to-graph mapping
 
 To map sequences against a graph, you should prepare the graph in the [GFA