From 0d50b5640e4a32c8f3c9fa45973a1e644a368fac Mon Sep 17 00:00:00 2001 From: Florin Pop Date: Tue, 26 Feb 2019 22:13:06 +0200 Subject: [PATCH] Added Example Guide --- Example Guide.md | 26 ++++++++++++++++++++++++++ README.md | 15 +++++++++++---- 2 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 Example Guide.md diff --git a/Example Guide.md b/Example Guide.md new file mode 100644 index 00000000..dbfbd5f3 --- /dev/null +++ b/Example Guide.md @@ -0,0 +1,26 @@ +## Application Name + +Add a clear and descriptive description of the application. +Answer to the following questions: + +- "What is the main purpose of this application?" +- "Is there any resource needed in order to complete the project?" - If the answer is yes, make sure you add it + +## User Stories + +- [ ] first user story +- [ ] second user story +- [ ] third user story +- [ ] forth user story +- [ ] fifth user story +- etc... + +## Bonus features + +- [ ] first bonus feature +- [ ] second bonus feature +- etc... + +## Useful links and resources + +Add all the useful links and resources corresponding to this project. diff --git a/README.md b/README.md index 9619331c..7d1da6f0 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ ## App Ideas Collection -Did you ever wanted to build something but you had no idea what to do? Are you sick of all the ToDo app ideas? +Did you ever wanted to build something but you had no idea what to do? Welcome to the **biggest collection** of app ideas you could build to improve your coding skills and why not, to impress your next employer with a shiny portfolio! -Not only that you'll find a list of projects but each project has _User Stories_ (a list of ToDo's) which will guide you through the process. +Not only that you'll find a list of projects but each project has the following features which will guide you through the process: -Also, each project will have a Trello Board ready for you to clone and use to track your progress. +1. The main objective of the project +2. A list of minimal _User Stories_ which have to be implemented +3. A list of bonus features to improve the base project +4. A Trello Board that can be cloned and used to track your progress -After you choose your project, make sure you clone the Trello Board corresponding to it. +### Projects + +## Contribution + +If you want to contribute you can open a PR by following the [Contribution Guide](./Contribution%20Guide.md). ## To Do