Restructured landing page

jakobilab · Feb 23, 2018 · 1897f56 · 1897f56
1 parent b058af0
commit 1897f56
Showing 1 changed file with 27 additions and 2 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,12 +3,37 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to circtools' documentation!
-=====================================
+==================================================================
+circtools - a one-stop software solution for circular RNA research
+==================================================================
 
+Introduction
+============
+
+Circular RNAs (circRNAs) originate through back-splicing events from linear primary transcripts, are resistant to exonucleases, typically not polyadenylated, and have been shown to be highly specific for cell type and developmental stage. Although few circular RNA molecules have been shown to exhibit miRNA sponge function, for the vast majority of circRNAs however, their function is yet to be determined.
+
+The prediction of circular RNAs is a multi-stage bioinformatics process starting with raw sequencing data and usually ending with a list of potential circRNA candidates which, depending on tissue and condition may contain hundreds to thousands of potential circRNAs. While there already exist a number of tools for the prediction process (e.g. DCC and circTest), publicly available downstream analysis tools are rare.
+
+We developed **circtools**, a modular, Python3-based framework for circRNA-related tools that unifies several functionalities in single command line driven software. The command line follows the `circtools subcommand` standard that is employed in samtools or bedtools. Circtools includes modules for RBP enrichment screenings, circRNA primer design, as well as interfaces to the processing tools FUCHS and DCC; miRNA seed analysis and differential exon usage will we available in the upcoming release.
+
+We intend to add more and more modules in the future in order to provide a comprehensive bioinformatics toolbox and also encourage users to contribute modules to circtools.
+
+Table of contents
+============
 .. toctree::
    :maxdepth: 2
 
    Index.md
    Modules.md
    Usage.md
+
+License
+============
+circtools is freely available under a GNU General Public License v3.0.
+
+
+Issues
+===============
+
+Problems or issues should be reported `via the GitHub issue system <https://github.com/dieterich-lab/circtools/issues/new>`_.
+