README-template
README template to be used in future projects.
Table of Contents
- Table of Contents
- Introduction
- Context
- Motivation
- Proposed Solution
- Features
- Requirements
- Setup
- Usage
- Output
- File Structure
- Technical Implementation
- Experimental Results
- Conclusions
- Development Guide
- Future Work
Introduction
Brief description of the project.
Context
Description of the context in which the project was developed.
Motivation
Reasons for developing the project.
Proposed Solution
Detailed solution proposed by this project that addresses the problems that led to its creation.
Features
- Highly flexibile
- Highly customizable
- Easy integration with different websites
- etc...
Requirements
- Python
- PIP
- etc...
Description on how to install and meet the requirements.
Setup
Make sure you comply with the Requirements.
Description of how to prepare the project once the requirements have been carried out.
Usage
Make sure you comply with the Requirements and Setup.
Description on how to use the project with examples.
Output
Example of the output format.
File Structure
# Important project components
.
├── directory1 - # Folder description
│ ├── __init__.py - # File description
│ └── ... - # Description of the files
├── script.py - # Main script
├── img - # README images
└── directory2 - # Folder description
├── __init__.py - # File description
└── ... - # Description of the filesTechnical Implementation
Technical description of how the project has been implemented.
Experimental Results
Some examples and the results obtained.
Conclusions
Overall conclusions of the project.
Development Guide
Guide on how to develop and add different functionalities to the project.
X Module
x
Y Module
y
Future Work
- Develop x modules.
- Print y.
- etc...