https://github.com/seqan/seqan
Tip revision: 394776e37461fb89db0f404664dd50aacc2f8fd9 authored by Enrico Siragusa on 14 July 2014, 13:40:44 UTC
Merge branch 'hotfix/masai-0.7.2'
Merge branch 'hotfix/masai-0.7.2'
Tip revision: 394776e
README
SeqAn
The Library for Sequence Analysis
http://www.seqan.de
Table Of Contents
1. What is SeqAn?
2. License
3. Supported Platforms
4. Prerequisites
5. For The Impatient
6. Documentation Resources
7. Contact
===========================================================================
1. What Is SeqAn?
===========================================================================
SeqAn is an open source C++ library of efficient algorithms and data
structures for the analysis of sequences with the focus on biological data.
Our library applies a unique generic design that guarantees high performance,
generality, extensibility, and integration with other libraries. SeqAn is
easy to use and simplifies the development of new software tools with a
minimal loss of performance.
===========================================================================
2. License
===========================================================================
The SeqAn library itself, the tests and demos are licensed under the very
permissing 3-clause BSD License. The licenses for the applications themselves
can be found in the LICENSE files.
===========================================================================
3. Supported Platforms
===========================================================================
Visual C++ 8, 9, 10, 11
MinGW
LLVM >= 3.0
GCC >= 4.1
===========================================================================
4. Prerequisites
===========================================================================
Supported C++ compiler
CMake (http://cmake.org/)
===========================================================================
5. For the Impatient
===========================================================================
Assuming that you have checked out the repository already, all
prerequisites are installed and you are on Linux or Mac Os X:
$ mkdir build/Debug
$ cd build/Debug
$ cmake ../.. -DCMAKE_BUILD_TYPE=Debug
$ make test_basic
$ ./core/tests/basic/test_basic
... the tests for module basic will run ...
===========================================================================
6. Documentation Resources
===========================================================================
Getting Started
https://trac.seqan.de/wiki/Tutorial/GettingStarted
Tutorial
http://trac.seqan.de/wiki/Tutorial
How Tos
http://trac.seqan.de/wiki/HowTo
Stable Documentation
http://docs.seqan.de/seqan/1.4/
Nightly Documentation (updated, more recent!)
http://docs.seqan.de/seqan/dev/
Changelog
http://trac.seqan.de/wiki/ChangeLog
Known Issues
http://trac.seqan.de/wiki/KnownIssues
===========================================================================
7. Contact
===========================================================================
Mailing List
https://lists.fu-berlin.de/listinfo/seqan-dev#subscribe
Bug Tracker, Wiki
http://trac.seqan.de