From 117a1376a0cabaf75d21d00a95b697a139adb3f1 Mon Sep 17 00:00:00 2001 From: Joe Wallwork <22053413+jwallwork23@users.noreply.github.com> Date: Mon, 25 Nov 2024 16:27:08 +0000 Subject: [PATCH] Improve clarity of README.md --- .dev/README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/.dev/README.md b/.dev/README.md index 7d93e2a..9f2a595 100644 --- a/.dev/README.md +++ b/.dev/README.md @@ -2,12 +2,19 @@ **CODE IN THIS SUBDIRECTORY IS NOT INTENDED FOR GENERAL USERS** -Recommended approach: +First, ensure that any existing `setup.sh`, `build.sh`, or `run.sh` scripts are backed up / moved to another location. +Alternatively, skip any step that isn't needed. + +Starting from the location where you cloned GISS-GC (i.e., `${GISS_HOME}`): ``` -cp .dev/utils/*.sh . +cp .dev/utils/setup.sh . source setup.sh + +cp .dev/utils/build.sh . ./build.sh --help -# Then build with the options you want +# This should show some options. Build with the options you want. + +cp .dev/utils/run.sh . ./run.sh --help -# Then run with the options you want +# This should show some options. Run with the options you want. ```