From 8136a1996417007e965d2f950e1c81ace2b80158 Mon Sep 17 00:00:00 2001
From: Kevin Klein <kevin@0x002A.com>
Date: Tue, 20 Jul 2021 22:09:09 +0200
Subject: [PATCH] Update README

---
 README.md                | 32 ++++++++++++++++++++++++++++----
 include/ms/graph/Graph.h |  6 ++----
 2 files changed, 30 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 6fd0835..43435bd 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,39 @@
-# LazyBastardOnMate
+# MuCHSALSA
 
-LazyBastard which is running faster after consuming a lot of mate iced tea.
+**Mu**lti-**C**ore **H**ybrid **S**hort- **A**nd **L**ong-read **S**equence **A**ssembler
+
+Based on:
+Gatter, Thomas, et al. "Economic genome assembly from low coverage Illumina and Nanopore data." 20th International
+Workshop on Algorithms in Bioinformatics (WABI 2020). Schloss Dagstuhl-Leibniz-Zentrum für Informatik, 2020.
+
+# Binary
+
+A statically linked binary for x86-64 can be downloaded from the releases page on GitHub.
+
+# Usage
+
+In contrast to [LazyB](https://github.com/TGatter/LazyB) this tool has an additional parameter to control the level of
+parallelization. Simply plug it into the LazyB-pipeline and set the additional parameter.
+**ATTENTION**: If no value is given all available cores will be used.
 
 # Building
 
-Building the project requires cmake and can be done by running the following commands:
+Building the project requires **cmake**, **clang-12** and **libc++-12** and can be done by running the following
+commands:
+
+```bash
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release ..
+make
+```
+
+If you want to link _libc++_ statically:
 
 ```bash
 mkdir build
 cd build
-cmake ..
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_BUILD_FAT_EXE=1 ..
 make
 ```
 
diff --git a/include/ms/graph/Graph.h b/include/ms/graph/Graph.h
index 7f1c2a5..3f567b5 100644
--- a/include/ms/graph/Graph.h
+++ b/include/ms/graph/Graph.h
@@ -661,16 +661,14 @@ class DiGraph final : public GraphBase {
   /**
    * Returns the std::unordered_map containing the mapping of all Vertex instances to their in-degrees.
    *
-   * @return A const reference to the std::unordered_map containing the mapping of all Vertex instances to their
-   *         in-degrees
+   * @return A const reference to the std::unordered_map mapping all Vertex instances to their in-degrees
    */
   auto const &getInDegrees() const;
 
   /**
    * Returns the std::unordered_map containing the mapping of all Vertex instances to their out-degrees.
    *
-   * @return A const reference to the std::unordered_map containing the mapping of all Vertex instances to their
-   *         out-degrees
+   * @return A const reference to the std::unordered_map mapping all Vertex instances to their out-degrees
    */
   auto const &getOutDegrees() const;