README.md

   1 [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.16344.svg)](http://dx.doi.org/10.5281/zenodo.16344)
   2 [![Build Status](https://travis-ci.org/bioperl/bioperl-live.svg?branch=master)](https://travis-ci.org/bioperl/bioperl-live)
   3 [![Coverage Status](https://coveralls.io/repos/bioperl/bioperl-live/badge.png?branch=master)](https://coveralls.io/r/bioperl/bioperl-live?branch=master)
   4 [![Documentation Status](https://readthedocs.org/projects/bioperl/badge/?version=latest)](https://readthedocs.org/projects/bioperl/?badge=latest)
   5
   6 # About BioPerl
   7
   8 BioPerl is a project for development of free and open source Perl
   9 tools for computational molecular biology.  For example, it includes
  10 classes for biological sequences, readers of multiple formats,
  11 sequence alignments, database searching objects, and interfaces to
  12 multiple programs such as EMBOSS, ClustalW, and BLAST.
  13
  14 The BioPerl project has developed multiple module distributions for
  15 different purposes.  The one named BioPerl (named after the project)
  16 provides the foundation for all others distributions.
  17
  18 This is the repository for the BioPerl distribution only.  Other
  19 distributions have [their own
  20 repositories](https://github.com/bioperl/).
  21
  22 # Installation
  23
  24 BioPerl distribution has the same name as the BioPerl.  However, the
  25 BioPerl distribution only includes a subset of the project modules.
  26 Because of this, the meaning of "installing BioPerl" is rarely clear.
  27 Instead of "install BioPerl", the aim must be "install module X".
  28
  29 [CPAN.org](https://www.cpan.org/modules/INSTALL.html) provides an
  30 overview on how to install and manage Perl modules but the bottom-line
  31 is:
  32
  33 1. find the module you need, for example `Bio::DB::EUtilities`
  34 2. install it with `cpanm`, for example `cpanm Bio::DB::EUtilities`
  35
  36 Alternatively, some Linux distributions have packaged BioPerl and have
  37 it available through their package manager.
  38
  39 # Documentation and Support
  40
  41 Documentation for individual modules is in POD and can also be read
  42 online at [metacpan](https://metacpan.org/pod/BioPerl).  Useful
  43 documentation in the form of example code can also be found in the
  44 `examples/` and `bin/` directories.
  45
  46 Additional resources and information about the project is available on
  47 the [project website](https://bioperl.org), with discussion happening
  48 on the [bioperl-l@bioperl.org](mailto: bioperl-l@bioperl.org) mailing
  49 list, and on the `#bioperl` channel of the freenode IRC server.
  50
  51 Bug reports are handle on the distribution github page.
  52
  53 # Development
  54
  55 See the [`HACKING.md`](HACKING.md) file for details on the project
  56 structure, such as building from source and running the test suite.