Skip to content

Commit

Permalink
added read and license file for PlastLib
Browse files Browse the repository at this point in the history
  • Loading branch information
genscale-admin committed Nov 20, 2015
1 parent 9977a13 commit 2ec8902
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
14 changes: 14 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
*****************************************************************************
* *
* PLAST : Parallel Local Alignment Search Tool *
* Copyright (c) 2009-2015 Inria *
* *
* PLAST is free software; you can redistribute it and/or modify it under *
* the Affero GPL v3 License *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* Affero GPL v3 License for more details. *
*****************************************************************************

57 changes: 57 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
PLAST - c++ project
===================

This project contains:
----------------------

1. C++/11 source code ('src' directory);

2. sample Fasta files to test software ('db' directory);

3. cmake file to compile the project.


Requirements
------------

1. cmake 2.6 or above;
2. gcc 4.4+ (Linux), gcc/Mingw64 (Windows) or clang (MacOSX) compiler.


Compiling PLAST
---------------

The PLAST library can be compiled in a terminal with the cmake tool. Once the source
archive has been retrieved and unzipped, one just has to do:

mkdir build
cd build
cmake ..
make

As a result, one should get a dynamic library (in 'build/lib' directory) and a binary
(in 'build/bin' directory).

This procedure works both on Linux and MacOs.

For Windows, the Mingw64 environment has first to be deployed since the GCC compiler is
needed for compiling PLAST (due to GCC intrinsics use). Then, one has to do:

mkdir build
cd build
cmake -G "MSYS Makefiles" ..
make


Developer documentation
-----------------------

See https://project.inria.fr/plast/developer-guide/


License
-------

PLAST is free software; you can redistribute it and/or modify it under the Affero GPL v3
license. See http://www.gnu.org/licenses/agpl-3.0.en.html

0 comments on commit 2ec8902

Please sign in to comment.