From 42ba2ad19784482d6323498179b07c5c3f37514e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Plaza=20O=C3=B1ate?= <florian.plaza-onate@inrae.fr> Date: Fri, 23 Aug 2024 11:17:18 +0200 Subject: [PATCH] Update README --- README | 61 ++++++---------------------------------------------------- 1 file changed, 6 insertions(+), 55 deletions(-) diff --git a/README b/README index efb4a7e..d234990 100644 --- a/README +++ b/README @@ -1,3 +1,6 @@ +WARNING: this is the legacy version of Meteor. +We strongly encourage using the new version of Meteor (aka Meteor 2) available here: https://github.com/metagenopolis/meteor + ======================================================================= Release notes for Meteor Version 3.2.1 ======================================================================= @@ -27,61 +30,9 @@ In the package, files are organized as follows: Installation notes for Meteor Version 3.2.1 ====================================================================== - 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. - -Building and running pre-requisite -================================== - - 1. Compiler collections with c++98 support (e.g. g++ or clang++) - - 2. Ruby interpreter version 1.9 or later, with "iniparse" rubygem module version 1.5.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. - -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 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 iniparse (>= 1.5.0). - - As root or sudoer: - gem install iniparse - - As common user (every user of meteor will have to do this): - gem install iniparse --user-install - +Meteor can be installed with conda: +conda create -n meteor_env meteor-legacy -c fplazaonate -c bioconda -c conda-forge +conda activate meteor_env ====================================================================== Usage of Meteor Version 3.2.1 -- GitLab