From c96247825887a05294953b3e098253ce900cd6df Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Sat, 8 Jun 2019 00:24:23 +0530 Subject: [PATCH] Added usage, added emojis --- README Templates/Hackathon.md | 72 +++++++++++++++++------------------ 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/README Templates/Hackathon.md b/README Templates/Hackathon.md index f6bcbe4..92ee847 100644 --- a/README Templates/Hackathon.md +++ b/README Templates/Hackathon.md @@ -20,56 +20,50 @@

-## Table of Contents -+ [Problem Statement](#problem_statement) -+ [Idea / Solution](#idea) -+ [Dependencies / Limitations](#limitations) -+ [Future Scope](#future_scope) -+ [Setting up a local environment](#getting_started) -+ [Technology Stack](#tech_stack) -+ [Contributing](../CONTRIBUTING.md) -+ [Authors](#authors) -+ [Acknowledgments](#acknowledgments) +## πŸ“ Table of Contents +- [Problem Statement](#problem_statement) +- [Idea / Solution](#idea) +- [Dependencies / Limitations](#limitations) +- [Future Scope](#future_scope) +- [Setting up a local environment](#getting_started) +- [Technology Stack](#tech_stack) +- [Contributing](../CONTRIBUTING.md) +- [Authors](#authors) +- [Acknowledgments](#acknowledgments) -## Problem Statement +## 🧐 Problem Statement It is useful to design and follow a specific format when writing a problem statement. While there are several options for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain focus on defining the problem. -+ IDEAL: This section is used to describe the desired or β€œto be” state of the process or product. At large, this section +- IDEAL: This section is used to describe the desired or β€œto be” state of the process or product. At large, this section should illustrate what the expected environment would look like once the solution is implemented. -+ REALITY: This section is used to describe the current or β€œas is” state of the process or product. -+ CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon. +- REALITY: This section is used to describe the current or β€œas is” state of the process or product. +- CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon. This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth. Following this format will result in a workable document that can be used to understand the problem and elicit requirements that will lead to a winning solution. -## Idea / Solution +## πŸ’‘ Idea / Solution This section is used to describe potential solutions. Once the ideal, reality, and consequences sections have been completed, and understood, it becomes easier to provide a solution for solving the problem. -## Dependencies / Limitations -+ What are the dependencies of your project? -+ Describe each limitation in detailed but concise terms -+ Explain why each limitation exists -+ Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire. -+ Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if +## ⛓️ Dependencies / Limitations +- What are the dependencies of your project? +- Describe each limitation in detailed but concise terms +- Explain why each limitation exists +- Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire. +- Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if appropriate, describe how these limitations could point to the need for further research. -## Future Scope +## πŸš€ Future Scope Write about what you could not develop during the course of the Hackathon; and about what your project can achieve in the future. -## Built With -+ [MongoDB](https://www.mongodb.com/) - Database -+ [Express](https://expressjs.com/) - Server Framework -+ [VueJs](https://vuejs.org/) - Web Framework -+ [NodeJs](https://nodejs.org/en/) - Server Environment - -## Getting Started +## 🏁 Getting Started These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. @@ -97,16 +91,22 @@ And repeat until finished ``` -End with an example of getting some data out of the system or using it for a little demo. +## 🎈 Usage +Add notes about how to use the system. -## Authors +## ⛏️ Built With +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [VueJs](https://vuejs.org/) - Web Framework +- [NodeJs](https://nodejs.org/en/) - Server Environment -+ [@kylelobo](https://github.com/kylelobo) - Idea & Initial work +## ✍️ Authors +- [@kylelobo](https://github.com/kylelobo) - Idea & Initial work See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project. -## Acknowledgments -+ Hat tip to anyone whose code was used -+ Inspiration -+ References +## πŸŽ‰ Acknowledgments +- Hat tip to anyone whose code was used +- Inspiration +- References