Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

create documentation for web application #7

Open
ebonnecab opened this issue Jun 2, 2020 · 4 comments
Open

create documentation for web application #7

ebonnecab opened this issue Jun 2, 2020 · 4 comments
Assignees
@FawziyahAlebiosu

Comments

@ebonnecab
Copy link
Collaborator

we need a readme file
@FawziyahAlebiosu
Copy link
Member

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.

@amy-lei
Copy link
Member

amy-lei commented Jun 2, 2020

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
Copy link
Collaborator Author

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

@ebonnecab ebonnecab reopened this Jun 2, 2020
@ebonnecab
Copy link
Collaborator Author

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

@FawziyahAlebiosu FawziyahAlebiosu self-assigned this Jun 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@FawziyahAlebiosu FawziyahAlebiosu

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@FawziyahAlebiosu @ebonnecab @amy-lei