Update README

CNAG-Biomedical-Informatics · Feb 11, 2025 · e84a24a · e84a24a
1 parent 047c2b5
commit e84a24a
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 4 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,6 @@
 Revision history for Perl distribution Pheno-Ranker
 
-1.04 2025-0X-0X:00:00Z (Manuel Rueda <mrueda@cpan.org>)
+1.04 2025-02-11:00:00Z (Manuel Rueda <mrueda@cpan.org>)
 
  - Set .Inline at user's home dir
 

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/CNAG-Biomedical-Informatics/pheno-ranker/badge.svg?branch=main)](https://coveralls.io/github/CNAG-Biomedical-Informatics/pheno-ranker?branch=main)
 [![CPAN Publish](https://github.com/cnag-biomedical-informatics/pheno-ranker/actions/workflows/cpan-publish.yml/badge.svg)](https://github.com/cnag-biomedical-informatics/pheno-ranker/actions/workflows/cpan-publish.yml)
 [![Kwalitee Score](https://cpants.cpanauthors.org/dist/Pheno-Ranker.svg)](https://cpants.cpanauthors.org/dist/Pheno-Ranker)
-![version](https://img.shields.io/badge/version-1.03-28a745)
+![version](https://img.shields.io/badge/version-1.04-28a745)
 [![Docker Build](https://github.com/cnag-biomedical-informatics/pheno-ranker/actions/workflows/docker-build.yml/badge.svg)](https://github.com/cnag-biomedical-informatics/pheno-ranker/actions/workflows/docker-build.yml)
 [![Docker Pulls](https://badgen.net/docker/pulls/manuelrueda/pheno-ranker?icon=docker&label=pulls)](https://hub.docker.com/r/manuelrueda/pheno-ranker/)
 [![Docker Image Size](https://badgen.net/docker/size/manuelrueda/pheno-ranker?icon=docker&label=image%20size)](https://hub.docker.com/r/manuelrueda/pheno-ranker/)
@@ -135,9 +135,15 @@ Please follow [these instructions](https://cnag-biomedical-informatics.github.io
 
 ### Method 3: From GitHub
 
+To clone the repository for the first time:
+
     git clone https://github.com/cnag-biomedical-informatics/pheno-ranker.git
     cd pheno-ranker
 
+To update an existing clone, navigate to the repository folder and run:
+
+    git pull
+
 Install system level dependencies:
 
     sudo apt-get install cpanminus libperl-dev
@@ -159,6 +165,10 @@ To ensure Perl recognizes your local modules every time you start a new terminal
 
     echo 'eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)' >> ~/.bashrc
 
+To **update** to the newest version (showing commands for Option 2):
+
+    cpanm Pheno::Ranker
+
 _Optional:_ If you want to use `utils/barcode` or `utils/bff_pxf_plot`:
 
     sudo apt-get install python3-pip libzbar0

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.03
+1.04
diff --git a/bin/pheno-ranker b/bin/pheno-ranker
@@ -367,9 +367,15 @@ Please follow L<these instructions|https://cnag-biomedical-informatics.github.io
 
 =head3 Method 3: From GitHub
 
+To clone the repository for the first time:
+
   git clone https://github.com/cnag-biomedical-informatics/pheno-ranker.git
   cd pheno-ranker
 
+To update an existing clone, navigate to the repository folder and run:
+
+  git pull
+
 Install system level dependencies:
   
   sudo apt-get install cpanminus libperl-dev
@@ -391,6 +397,10 @@ To ensure Perl recognizes your local modules every time you start a new terminal
 
   echo 'eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)' >> ~/.bashrc
 
+To B<update> to the newest version (showing commands for Option 2):
+
+  cpanm Pheno::Ranker
+
 I<Optional:> If you want to use C<utils/barcode> or C<utils/bff_pxf_plot>:
 
   sudo apt-get install python3-pip libzbar0

diff --git a/lib/Pheno/Ranker.pm b/lib/Pheno/Ranker.pm
@@ -28,7 +28,7 @@ $SIG{__DIE__}  = sub { die BOLD RED "Error: ", @_ };
 
 # Global variables:
 $Data::Dumper::Sortkeys = 1;
-our $VERSION   = '1.03';
+our $VERSION   = '1.04';
 our $share_dir = dist_dir('Pheno-Ranker');
 
 # Set development mode