A template to make good README.md

FYP-Template.md

Final Year Project Title

One Paragraph of project description goes here

Getting Started

These instructions will help you get started with a solid lframework for your final year project at the Limerick Institute of Technology.

Prerequisites

What things you need (software, hardware, services, software as a service)

Give examples

Workflow

A step by step series explaining how you intend to produce your work.

Be specific.

Give the example

And repeat.

until finished

End with an example, perhaps with a key frame, avatar, icon, or title screen.

Primary Interaction

Specify the primary interaction you wish from a viewer of your work or a user of your deployed service.

Iterations

Explain how you will iterate your work.

Break down into production tests.

Document your production and post-production process.

Give an example

Deployment

Add additional notes about how to deploy your final year project.

Built With

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Authors

• Billie Thompson - Initial work - PurpleBooth
• Bernie Goldbach - Iterated for creative media - Topgold

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

License

This project is licensed under the MIT License - see the LICENSE.md file for details