Skip to content
Snippets Groups Projects
Commit 0dbaa184 authored by Franck Gauthier's avatar Franck Gauthier
Browse files

add README

parent a34453d2
No related branches found
No related tags found
No related merge requests found
......@@ -7,6 +7,8 @@ Files and directories
In the package, files are organized as follows:
-+- README: This file
|
+- INSTALL: Building and installation instructions from the sources for all supported systems.
|
+- COPYING: License
|
......@@ -25,59 +27,59 @@ In the package, files are organized as follows:
Installation notes for Meteor Version 3.2
======================================================================
This file describes the building and installation instructions from the SOURCES for UNIX like systems.
NB: Building and running Meteor on MS Windows system has not been tested,
but should easily be achieved as Meteor uses standard C++ code without any exotic dependencies.
This file describes the building and installation instructions from the SOURCES for UNIX like systems.
NB: Building and running Meteor on MS Windows system has not been tested,
but should easily be achieved as Meteor uses standard C++ code without any exotic dependencies.
Supported Systems
=================
Will work in most modern GNU/Linux, and macOS (10.5 or later with Intel processor) systems.
Will work in most modern GNU/Linux, and macOS (10.5 or later with Intel processor) systems.
Building and running pre-requisite
==================================
1. Compiler collections with c++98 support (e.g. g++ or clang++)
1. Compiler collections with c++98 support (e.g. g++ or clang++)
2. Ruby interpreter version 1.9 or later, with "inifile" rubygem module version 3.0.0 or later
2. Ruby interpreter version 1.9 or later, with "inifile" rubygem module version 3.0.0 or later
3. bowtie2 version 2.3.5.1 or later, and bowtie 1.2.3 or later if you plan to use color space SOLiD data.
3. bowtie2 version 2.3.5.1 or later, and bowtie 1.2.3 or later if you plan to use color space SOLiD data.
Installation
============
On a GNU/Linux system, we recommand to have g++, make and ruby installed via the package manager of your distribution.
e.g.:
on Debian/Ubuntu plateforms (as root or sudoer):
apt-get install make g++ ruby
on Redhat/Fedora/CentOS plateforms (as root or sudoer):
yum install make gcc-c++ ruby
- To build Meteor, open a terminal and execute the following commands:
cd meteor-pipeline/src/
make
This will create two binaries (meteor-counter and meteor-profiler) in the folder meteor-pipeline/src/build/
- Now copy the meteor pipeline executables in a folder present in the PATH environment variable.
e.g. as root or sudoer (this will install meteor for all user):
cp build/meteor-counter build/meteor-profiler ../meteor.rb /usr/local/bin
Or as common user (every user of meteor will have to do this):
[ ! -d ~/bin ] && mkdir ~/bin
cp build/meteor-counter build/meteor-profiler ../meteor.rb ~/bin
- Then install the ruby module inifile (>= 3.0.0).
As root or sudoer:
gem install inifile
As common user (every user of meteor will have to do this):
gem install inifile --user-install
On a GNU/Linux system, we recommand to have g++, make and ruby installed via the package manager of your distribution.
e.g.:
on Debian/Ubuntu plateforms (as root or sudoer):
apt-get install make g++ ruby
on Redhat/Fedora/CentOS plateforms (as root or sudoer):
yum install make gcc-c++ ruby
- To build Meteor, open a terminal and execute the following commands:
cd meteor-pipeline/src/
make
This will create two binaries (meteor-counter and meteor-profiler) in the folder meteor-pipeline/src/build/
- Now copy the meteor pipeline executables in a folder present in the PATH environment variable.
e.g. as root or sudoer (this will install meteor for all user):
cp build/meteor-counter build/meteor-profiler ../meteor.rb /usr/local/bin
Or as common user (every user of meteor will have to do this):
[ ! -d ~/bin ] && mkdir ~/bin
cp build/meteor-counter build/meteor-profiler ../meteor.rb ~/bin
- Then install the ruby module inifile (>= 3.0.0).
As root or sudoer:
gem install inifile
As common user (every user of meteor will have to do this):
gem install inifile --user-install
======================================================================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment