What is the purpose of the project? This project is guidance for users creating an informative readme file for any project. This can be used directly or as inspiration. Tailor it to the needs of the project. Sections can be added or removed.
Domain knowledge relevant to project. According to WiseGeek.com,
"A readme file is a text file that is often included with software that contains general information or instructions about the software. The specific nature of this information varies significantly from file to file...There is no general formula for writing a readme, however, and in the end the content depends on the whims of the developer."
The requirements for sharing your project. If possible, include links, such as the link to a presentation.
Where you got the data, inspiration, etc.
My first inspiration for writing Readme files from Maggie Giust's Heart Failure repository here.
Describe the columns in your final dataset. Use this link to easily create markdown tables.
| Feature Name | Description | Additional Info |
|---|---|---|
| x | time in hours | integer |
| y | count of observation | float |
First ideas about project while initially exploring the dataset.
A hypotheses that you test in your project. Feature x significantly increases with feature y.
Null hypothesis: Feature x does not correlate with feature y.
Alternative hypothesis: Feature x has a significant correlation with feature y.
A second hypotheses that you test in your project. Feature x significantly increases with feature y.
Null hypothesis: Feature x does not correlate with feature y.
Alternative hypothesis: Feature x has a significant correlation with feature y.
Short description for each step of the process.
- Short
- Description
Can use exandable text for large amounts of text.
Click to Expand
Text goes in here. Maybe an image.
If you add an empty line between the summary code and text.
- Short
- Description
Key insights from project.
What should the user viewing this project do to recreate the project?
- Fork or clone this repository.
- Copy and paste the contents of
- Copy_Pasta.md for headers alone.
- README.md for text with code used on different text, such as the expandable text.
- View your final results.
An Easy Way to Download
To save the file straight in your project directory, follow these steps:
- Click the file in this repository you want to copy and paste. It should open to the page as shown below.
- Right click raw.
- Click save as.
- Click the folder you want to save the file in, such as your project directory.
- Rename the file as README.md.
- Make sure the file is saving as a markdown file before clicking save.
- You can now edit the file how you want within your project directory.
What tools did you use and what version were they?
Python version 3.85
Your permissions for users when reproducing your project.
The names of all contributors for the project with contact information.