Skip to content

Commit

Permalink
doc: improve "Quick Start" section
Browse files Browse the repository at this point in the history
Mention that CICE must be cloned with '--recurse-submodules' for Icepack
to also be cloned, and fix the link to the Git Workflow Guide.
  • Loading branch information
phil-blain committed Oct 6, 2022
1 parent 007fbff commit e6a02b6
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions doc/source/intro/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
Quick Start
===========

Download the model from the CICE-Consortium repository,
https://github.com/CICE-Consortium/CICE
Clone the model from the CICE-Consortium repository,

Instructions for working in github with CICE (and Icepack) can be
found in the `CICE Git and Workflow Guide <https://github.com/CICE-Consortium/About-Us/wiki/Git-Workflow-Guidance>`_.
git clone --recurse-submodules https://github.com/CICE-Consortium/CICE

You will probably have to download some inputdata, see the `CICE wiki <https://github.com/cice-consortium/CICE/wiki>`_ or :ref:`force`.
Instructions for working with Git and GitHub with CICE (and Icepack) can be
found in the `CICE Git Workflow Guide <https://github.com/CICE-Consortium/About-Us/wiki/Git-Workflow-Guide>`_.

You will probably have to download some input data, see the `CICE wiki <https://github.com/cice-consortium/CICE/wiki>`_ or :ref:`force`.

Software requirements are noted in this :ref:`software` section.

Expand Down

0 comments on commit e6a02b6

Please sign in to comment.