add codespace instructions

#122, #93
NOAA-FIMS · Jun 20, 2024 · 5621be8 · 5621be8
1 parent efa9cc5
commit 5621be8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/06-developer-software-guide.Rmd b/06-developer-software-guide.Rmd
@@ -6,6 +6,20 @@ dependencies described in the [user installation
 guide](#user-installation-guide) which you should ensure are installed
 first.
 
+### Codespaces
+
+An alternative to setting up this software locally is using [GitHub Codespaces](https://docs.github.com/en/codespaces).
+
+The FIMS repository already has a file to set up all of the needed software, so there is no need to install anything locally.
+
+To start a codespace on the FIMS repository:
+1. Navigate to the FIMS repo at https://github.com/noaa-fims/fims
+2. click on the green "Code" button
+3. Click on the "Codespaces" tab from the pop up menu.
+4. Use the "+" button to create a codespace on main. Note the branch can be changed once the Codespace opens.
+
+![A screenshot of how to open a codespace on FIMS. The + button is circled in red.](fimscodespace.png)
+
 ### git
 
 You will need git installed locally, and you may prefer to use an

diff --git a/fimscodespace.png b/fimscodespace.png