Skip to content

Commit

Permalink
Improve clarity of README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jwallwork23 authored Nov 25, 2024
1 parent 06c7403 commit 117a137
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions .dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

0 comments on commit 117a137

Please sign in to comment.