search

UBC-MDS / obesity-explorer

A dashboard project for Group #1
https://obesity-explorer.herokuapp.com/
MIT License
0 stars 5 forks source link

Updating Readme #31

Closed jraza19 closed 3 years ago

jraza19 commented 3 years ago

Expand on the README file to be a welcoming place for anyone coming to your project for the first time. For your project, your README should cater to at least two groups of people (on bigger projects these can be separated and put in different files):

Those potentially interested in using your dashboard:

Include motivation behind your project and clearly explain what problem you are solving and why it is important. You do not have to include detailed usage instructions, just high level what they can do in your dashboard and and the deployed link. This is a good example

Those interesting in helping you develop your dashboard Potential contributors are interested in the above as well, but also need to know how they can install your app and how to run it locally (maybe they are great in Altair but have never used Dash). Suggestions for what you would like help with and how to work in your project, some of this can go in contributing also. This is an example of a program I made as part of my thesis.

rtaph commented 3 years ago

Improved the README by introducing a GIF. See #45.