From 640fe966cb96aeedafedd18d4c6080cefb455bd1 Mon Sep 17 00:00:00 2001
From: Sakib Rahman <rahmans@myumanitoba.ca>
Date: Sun, 24 Nov 2024 01:07:29 +0000
Subject: [PATCH] Update readme

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 450f98911..18303f9ba 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,21 @@
-EIC software environment container
+EIC Software Environment Container
 ==================================
 
+## Installation Instructions 
+
 For installation instructions of `eic-shell`, see https://github.com/eic/eic-shell.
+
+## Updating a package
+
+### An individual package is updated on spack package repository along with a spack version upgrade
+This situation just requires modifying the eic-shell [yaml](https://eicweb.phy.anl.gov/containers/eic_container/-/blob/master/spack-environment/packages.yaml?ref_type=heads) file.
+
+#### An individual package is updated on spack package repository after a spack version upgrade
+
+This circumstance requires special cherry pick.
+
+Example:
+https://eicweb.phy.anl.gov/containers/eic_container/-/merge_requests/879/diffs
+
+In this example, the spack package xrootd had the latest version 5.6.9 which was put in after a spack version upgrade. We had to modify the eic-shell [spack.sh](https://eicweb.phy.anl.gov/containers/eic_container/-/blob/master/spack-environment/packages.yaml?ref_type=heads) file to include the commit hash of the version update from the main [spack](https://github.com/spack/spack/commits/develop/var/spack/repos/builtin/packages/xrootd/package.py) package repository in addition to modifying the eic-shell [yaml](https://eicweb.phy.anl.gov/containers/eic_container/-/blob/master/spack-environment/packages.yaml?ref_type=heads) file.  
+
-- 
GitLab