A brief description of your project here would help.
Describe how your repository is organized. What is found in each directory? Consider also mentioning explicitly any especially important or 'main' files.
Directory | Description |
---|---|
/data | contains raw and processed data files and processing scripts. |
/src | contains source codes used in the project. |
/docs | contains documentation, notes, writeups, and other text files. |
/results | contains major outputs of source codes, figures, tables, and the like. |
List any software dependencies.
Provide any info on troubleshooting, known issues or failure modes, contact info, or anything else you'd like to add.
List contributors who actively push changes.