From 98ceee7dac34a2cabf4581dfcb26a27606313d1f Mon Sep 17 00:00:00 2001
From: Serka-M <57069483+Serka-M@users.noreply.github.com>
Date: Thu, 6 Jun 2024 14:25:00 +0200
Subject: [PATCH] Update README.md
---
README.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 2706c83..a02346c 100644
--- a/README.md
+++ b/README.md
@@ -20,9 +20,10 @@ mmlong2-lite is the microbial genome production part of the [mmlong2](https://gi
### Schematic overview
+
## Installation
-### Installation from source (Conda):
+### Installation from source (Conda)
To create a local [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html) environment for running mmlong2-lite workflow, just copy-paste the following:
```
mamba create --prefix mmlong2-lite -c conda-forge -c bioconda snakemake=8.2.3 singularity=3.8.6 zenodo_get=1.6.1 pv=1.6.6 pigz=2.6 tar=1.34 -y
@@ -33,9 +34,10 @@ chmod +x mmlong2-lite/bin/mmlong2-lite
mmlong2-lite -h
```
After setting up the virtual environment, the required software dependencies will be automatically installed when running the workflow for the first time.
+
## Running mmlong2-lite
-### Full usage:
+### Full usage
```
MAIN SETTINGS:
-np --nanopore_reads Path to Nanopore reads (default: none)
@@ -67,13 +69,13 @@ ADVANCED SETTINGS:
-x --extra_inputs Extra inputs for Snakemake config file
```
-### Overview of result files:
+### Overview of result files
* `_assembly.fasta` - assembled and polished metagenome
* `_bins.tsv` - dataframe for automated binning results
* `dependencies.csv`- list of dependencies used and their versions
* `bins` - directory for metagenome assembled genomes
-### Additional documentation:
+### Additional documentation
* [Dataframe description](msc/mmlong2-lite-dfs.md)
* [Dependency list](msc/mmlong2-lite-dep.md)