diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md index 7c9736c99d9270d723a59c600d7ed222f6e00443..7b896a44a3beff961d91e9ecde71dc272f30509d 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 255a386e4856f4a40dd7b1632635f0fef0b6f293..d23f29fd991a6bdc7a33b436a96497b5158d67a2 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}