# DEVELOP Readme Template

The Markdown Readme text file should contain everything that someone would want to know about the code prior to downloading it.   

### Readme Resources
- [Readme 101](https://www.makeareadme.com/)
- [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/)
- Examples from past DEVELOP Projects 
    * [Peru Health & Air Quality Term II ](https://gitlab.developprogram.org/developcodecatalog/2021/fall-2021/ga-peru-health-and-air-quality-ii/-/blob/main/README.txt)  
    * [FLASH](https://gitlab.developprogram.org/developcodecatalog/2020/spring/flash/-/blob/master/README.md)  


# Software Name (ACRONYM)
**Project:** Insert Project Short Title     

**Node:** Insert DEVELOP Node Name (Example: Virginia Ð Langley)   

**Term:** Insert Term and Year  
**Previous Term:** Term and Year *(delete this field if this is the first term of the code)*  

**Team:** Name 1 (Project Lead), Name 2, Name 3, Name 4  
**Previous Team:** Name 1 (Project Lead), Name 2, Name 3, Name 4 *(delete this field if this is the first term of the code)*  

**Software Release POC:** Name, [Email] (add email address)         

## Introduction  
What motivated the creation of the software and how does this software address the problem? (1 paragraph, 3-5 sentences)  

## Applications and Scope   
Where will the software be used, and to what extent?   

## Capabilities 
What can this software do, how has it improved the way work is performed and decisions are made? 

## Interfaces 

### Languages
What languages does it use, how do the users actually interface with the end product?  

### Packages
What other libraries or software packages does it rely on?  
- List packages or software required for the code to work
- R
    - `rgdal`
    - `timeseries`
- Python
    - `xarray`
- etc.

## Parameters
Describe any steps needed for the script to run. It will help to specify which line in the code will need to be changed by the user based on their needs.  

1. step 1  
2. step 2 
3. include examples 

## Assumptions, Limitations, & Errors 
This is where limitations of the theory, model, science, etc should be briefly documented. If the tools only work for a specific scenario, say so.   

## Support
Tell people where they can go to for help. Provide links to chat rooms, include email addresses, relevant tutorials, etc. 

## Acknowledgments
Include acknowledgments of who helped develop the code.
- Name (Institution)