Here I'll be sharing my journey learning Python & R
Motivate your research question or business problem. Clearly explain which problem is solved.
First, introduce and motivate your chosen method, and explain how it contributes to solving the research question/business problem.
Second, summarize your results concisely. Make use of subheaders where appropriate.
Provide an overview of the directory structure and files, for example:
├── README.md
├── data
├── gen
│ ├── analysis
│ ├── data-preparation
│ └── paper
└── src
├── analysis
├── data-preparation
└── paper
Explain to potential users how to run/replicate your workflow. If necessary, touch upon the required input data, which secret credentials are required (and how to obtain them), which software tools are needed to run the workflow (including links to the installation instructions), and how to run the workflow.
Point interested users to any related literature and/or documentation.
Explain who has contributed to the repository. You can say it has been part of a class you've taken at Tilburg University.