From 01d01690416f49491468f2177bf040a69919ff6b Mon Sep 17 00:00:00 2001
From: selva <selvaganz1285@gmail.com>
Date: Fri, 7 Oct 2022 10:19:50 +0530
Subject: [PATCH] "Updated images for versions"
---
docs/source/getting_started.md | 2 ++
docs/source/index.md | 23 +++++++++++++++++------
2 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md
index 7c9736c..7b896a4 100644
--- a/docs/source/getting_started.md
+++ b/docs/source/getting_started.md
@@ -2,6 +2,8 @@
## Installation
+BiTIA is available on PyPi.
+
To get started with using BiTIA, you should [install Python] and make sure [python-pip] is installed with it on your system.
[install Python]: https://realpython.com/installing-python/
diff --git a/docs/source/index.md b/docs/source/index.md
index 255a386..d23f29f 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -1,15 +1,26 @@
-# Welcome to BiTIA's documentation!
-
## BioInformatics Tool for Infrastructure Automation (BiTIA)
+```{image} https://img.shields.io/pypi/v/bitia.svg
+:target: https://pypi.python.org/pypi/bitia
+```
+```{image} https://img.shields.io/pypi/pyversions/bitia.svg
+:target: https://www.python.org
+```
+
+
BiTIA makes it easy to orchestrate the infrastructure required to run
complex bioinformatics pipelines. BiTIA plays well with existing pipeline
-solution such as snakement. [See some examples]
+solution such as snakemake. [See some examples]
+
[see some examples]: examples
```{toctree}
-:hidden:
+:caption: Getting started
+:hidden: true
+:maxdepth: 1
+:name: getting_started
+
getting_started
developer
```
@@ -17,8 +28,8 @@ developer
If you want to learn how to use BiTIA, check out the following resources:
-- [Getting Started](getting_started)
-- [Features](features)
+- [Getting Started](getting_started.md)
+
```{eval-rst}
--
GitLab