Skip to content

Commit

Permalink
Added badge and folder descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
adcroft committed Jan 12, 2021
1 parent 5e75f43 commit 54969d2
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
Disclaimer
==========
# KID (icebergs)

The United States Department of Commerce (DOC) GitHub project code is provided
on an "as is" basis and the user assumes responsibility for its use. DOC has
relinquished control of the information and no longer has responsibility to
protect the integrity, confidentiality, or availability of the information. Any
claims against the Department of Commerce stemming from the use of its GitHub
project will be governed by all applicable Federal law. Any reference to
specific commercial products, processes, or services by service mark,
trademark, manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by the Department of Commerce. The
Department of Commerce seal and logo, or the seal and logo of a DOC bureau,
shall not be used in any manner to imply endorsement of any commercial product
or activity by DOC or the United States Government.
[![Documentation Status](https://readthedocs.org/projects/kid/badge/?version=latest)](https://kid.readthedocs.io/en/latest/?badge=latest)

This project code is made available through GitHub but is managed by NOAA-GFDL
at https://gitlab.gfdl.noaa.gov.
# What files are what

| File/directory | Purpose |
| -------------- | ------- |
| src/ | Source code for icebergs |
| driver/ | A driver for creating a stand-alone (uncoupled to ocean/atmosphere) model |
| build/ | A workspace for building a stand alone executable using src/ and driver/ |
| tests/ | Test cases |
| docs/ | A workspace for generating documentation with doxygen and sphinx |

# Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.

This project code is made available through GitHub but is managed by NOAA-GFDL at https://gitlab.gfdl.noaa.gov.

0 comments on commit 54969d2

Please sign in to comment.