MLH-Fellowship / 0.5.2-cms

Your one stop shop for maintaining and keeping track of the people you meet, and memorable details about them!
GNU General Public License v3.0
1 stars 0 forks source link

create documentation for web application #7

Open ebonnecab opened 4 years ago

ebonnecab commented 4 years ago

we need a readme file

FawziyahAlebiosu commented 4 years ago

things our readme should probably have:

amy-lei commented 4 years ago

things our readme should probably have:

  • what this is
  • what we built it with
  • features we have now
  • features we want to have in the future.

Will also be important to include how to run it locally! I'm not sure if we need to deploy it.

ebonnecab commented 4 years ago

I agree! It would be nice to deploy it if we're able to

ebonnecab commented 4 years ago

We should also include documentation for any resources we use to build the project