README.rst
1Fork of SeqAn for PacBio
2========================
3
4IMPORTANT NOTE
5--------------
6
7This is neither the official website for, nor official repository for, the SeqAn project. This is
8a public fork for use compiling PacBio's public software tools.
9
10If you are looking for the SeqAn home-page, it is here::
11
12 http://www.seqan.de
13
14If you are looking for the official SeqAn repository, it is here::
15
16 https://github.com/seqan/seqan.git
17
18What is this Repo
19-----------------
20
21This is a public fork of the SeqAn Library v2.0.0, stripped down to just the header files and
22with a few custom fixes.
23
24Some of PacBio's tools depend on SeqAn for efficient implementations of some common data-structures
25for sequence analysis (A huge thanks to SeqAn development team!). However PacBio only uses a small
26amount of the SeqAn code-base, and in addition requires a few minor fixes that didn't make it in to
27the initial release of SeqAn v2.0.0. Thus to minimize confusion and band-width, we will depend
28on this fork instead of SeqAn proper.
29
30How to patch
31------------
32
33All of the changes made to this library from the main SeqAn v2.0.0 release are available in
34seqan-library-v2.0.0.patch, and can be applied to a vanilla copy with the "patch" commandline
35tool.
36
37What Is SeqAn?
38--------------
39
40SeqAn is an open source C++ library of efficient algorithms and data structures for the analysis of sequences with the focus on biological data.
41Our library applies a unique generic design that guarantees high performance, generality, extensibility, and integration with other libraries.
42SeqAn is easy to use and simplifies the development of new software tools with a minimal loss of performance.
43
44License
45-------
46
47The SeqAn library itself, the tests and demos are licensed under the very permissing 3-clause BSD License.
48The licenses for the applications themselves can be found in the LICENSE files.
49
50
51Disclaimer
52----------
53
54THIS WEBSITE AND CONTENT AND ALL SITE-RELATED SERVICES, INCLUDING ANY DATA, ARE
55PROVIDED "AS IS," WITH ALL FAULTS, WITH NO REPRESENTATIONS OR WARRANTIES OF ANY
56KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTIES
57OF MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT OR FITNESS FOR A
58PARTICULAR PURPOSE. YOU ASSUME TOTAL RESPONSIBILITY AND RISK FOR YOUR USE OF
59THIS SITE, ALL SITE-RELATED SERVICES, AND ANY THIRD PARTY WEBSITES OR
60APPLICATIONS. NO ORAL OR WRITTEN INFORMATION OR ADVICE SHALL CREATE A WARRANTY
61OF ANY KIND. ANY REFERENCES TO SPECIFIC PRODUCTS OR SERVICES ON THE WEBSITES DO
62NOT CONSTITUTE OR IMPLY A RECOMMENDATION OR ENDORSEMENT BY PACIFIC BIOSCIENCES.
63