From 77ed2effc2dfa45a829b07f1440be3b6c6a72d81 Mon Sep 17 00:00:00 2001
From: George Marchment <georgemarchment@yahoo.fr>
Date: Tue, 20 Feb 2024 13:25:00 +0100
Subject: [PATCH] update readme
---
README.md | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 3d45a03..59e3151 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
This repository contains **BioFlow-Insight**, a Python software tool. **BioFlow-Insight** automatically analyses Nextflow workflow code, extracting useful information, notably in the form of visual graphs illustrating the workflow's structure and its various steps.
-**BioFlow-Insight** is easily installable as a Python package (see here). It is also accessible as a web service (see [here](https://bioflow-insight.pasteur.cloud/)).
+**BioFlow-Insight** is easily installable as a Python package (see here). It is also accessible as a free web service. For more information and to start using BioFlow-Insight, visit [here](https://bioflow-insight.pasteur.cloud/) (https://bioflow-insight.pasteur.cloud/).
<!--The outputs of **BioFlow-Insight** are saved in the results folder.-->
@@ -23,6 +23,7 @@ This repository contains **BioFlow-Insight**, a Python software tool. **BioFlow-
- [Input](#input)
- [Output](#output)
- [License](#license)
+ - [Funding](#funding)
## Installation
@@ -57,6 +58,8 @@ The 3 different graphs generated by **BioFlow-Insight** are :
2. The second graph represents operations without any inputs, along with processes and their dependencies. This graph, called the *dependency graph without branch operations*, is obtained by removing the branch operations and linking the remaining elements if a path exists between them in the original specification graph.
3. The final graph, called the *process dependency graph*, represents only processes and their dependencies. Similar to the latter, this graph is constructed by removing all operations, leaving only processes, and linking them based on their dependencies in the original specification graph.
+> For a more in-depth explanation of BioFlow-Insight functionnalities, visit its webpage [here](https://bioflow-insight.pasteur.cloud/) (https://bioflow-insight.pasteur.cloud/).
+
> To examplify **BioFlow-Insight** utilisation, let's use the rnaseq-nf workflow proposed by Nextflow (its source code can be found [here](https://github.com/nextflow-io/rnaseq-nf/tree/8253a586cc5a9679d37544ac54f72167cced324b)). Examples of the output are given below.
### Input
@@ -154,6 +157,12 @@ Here are some of the graphs which are generated by **BioFlow-Insight**, they are
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT)
+TODO -> add license to git repo
+
+## Funding
+
+This work received support from the National Research Agency under the France 2030 program, with reference to ANR-22-PESN-0007.
+
___
<img align="left" src="img/logo.png" width="16%">
--
GitLab