Merge pull request #168 from boegel/README.eessi

add `README` file to include in software.eessi.io
EESSI · Dec 2, 2023 · 83227dc · 83227dc
2 parents 8ee8206 + 9d0f273
commit 83227dc
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/roles/create_cvmfs_content_structure/files/README.eessi b/roles/create_cvmfs_content_structure/files/README.eessi
@@ -0,0 +1,20 @@
+EESSI - the European Environment for Scientific Software Installations
+
+Getting started
+---------------
+
+1) Set up your environment by sourcing the initialisation script for a particular version of EESSI:
+
+    source /cvmfs/software.eessi.io/versions/2023.06/init/bash
+
+2) Explore the software included in EESSI via the "module avail" command.
+
+3) Load one or more modules, and start running the software!
+
+
+Links
+-----
+
+website: https://eessi.io
+documentation: https://eessi.io/docs
+support: https://www.eessi.io/docs/support (contact [email protected] via e-mail)
diff --git a/roles/create_cvmfs_content_structure/vars/software.eessi.io.yml b/roles/create_cvmfs_content_structure/vars/software.eessi.io.yml
@@ -6,5 +6,9 @@ files:
     dest: ''
     mode: '644'
 
+  - name: README.eessi
+    dest: ''
+    mode: '644'
+
 symlinks:
   host_injections: '$(EESSI_HOST_INJECTIONS:-/opt/eessi)'