Fix build failure: add helpful error messages for missing git submodules and update docs

Agent-Logs-Url: https://github.com/ps2homebrew/pfsshell/sessions/d8026db8-eea1-457d-ba64-95844c366c8a

Co-authored-by: AKuHAK <621640+AKuHAK@users.noreply.github.com>

Author: Copilot

.github/workflows/ci.yml

@@ -9,7 +9,9 @@
         "**.hpp",
         "**.build",
         "**.in",
-        "**.yml"
+        "**.yml",
+        ".gitmodules",
+        "external/**"
       ]
     },
     "pull_request": {
@@ -20,7 +22,9 @@
         "**.hpp",
         "**.build",
         "**.in",
-        "**.yml"
+        "**.yml",
+        ".gitmodules",
+        "external/**"
       ]
     }
   },

README.md

@@ -157,6 +157,26 @@ The latest Open PS2 Loader revisions have a built-in NBD server. `pfsshell/pfsfu
 This project can be built by using the Meson build system. For more information
 about the system, please visit the following location: <https://mesonbuild.com/>
 
+The project uses git submodules to provide external dependencies. Before
+building, make sure to initialize all submodules:
+
+```sh
+git clone --recursive https://github.com/ps2homebrew/pfsshell.git
+```
+
+Or, if you have already cloned the repository:
+
+```sh
+git submodule update --init --recursive
+```
+
+Then build with Meson:
+
+```sh
+meson setup build/
+meson compile -C build/
+```
+
 ## Original project
 
 The original project was created by Wizard of Oz. More information about the original project can be found at the following location:

subprojects/apa/meson.build

@@ -1,5 +1,12 @@
 project('apa', 'c')
 
+fs = import('fs')
+if not fs.is_dir('include') or not fs.is_dir('src') or not fs.is_dir('irx')
+  error('The apa include/src/irx directories are missing. ' +
+        'This is likely because the git submodules have not been initialized. ' +
+        'Please run:\n  git submodule update --init --recursive')
+endif
+
 libfakeps2sdk_proj = subproject('fakeps2sdk')
 libfakeps2sdk_dep = libfakeps2sdk_proj.get_variable('libfakeps2sdk_dep')
 

subprojects/iomanX/meson.build

@@ -1,5 +1,12 @@
 project('iomanX', 'c')
 
+fs = import('fs')
+if not fs.is_dir('include') or not fs.is_dir('src')
+  error('The iomanX include/src directories are missing. ' +
+        'This is likely because the git submodules have not been initialized. ' +
+        'Please run:\n  git submodule update --init --recursive')
+endif
+
 libfakeps2sdk_proj = subproject('fakeps2sdk')
 libfakeps2sdk_dep = libfakeps2sdk_proj.get_variable('libfakeps2sdk_dep')
 

subprojects/pfs/meson.build

@@ -1,5 +1,12 @@
 project('pfs', 'c')
 
+fs = import('fs')
+if not fs.is_dir('include') or not fs.is_dir('src') or not fs.is_dir('irx')
+  error('The pfs include/src/irx directories are missing. ' +
+        'This is likely because the git submodules have not been initialized. ' +
+        'Please run:\n  git submodule update --init --recursive')
+endif
+
 libfakeps2sdk_proj = subproject('fakeps2sdk')
 libfakeps2sdk_dep = libfakeps2sdk_proj.get_variable('libfakeps2sdk_dep')