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

Improve README.md #29

Open
tomatocat opened this issue Jul 17, 2020 · 1 comment
Open

Improve README.md #29

tomatocat opened this issue Jul 17, 2020 · 1 comment
Assignees
@tomatocat
Labels
priority: low type: documentation Improvements or additions to documentation

Comments

@tomatocat
Copy link
Collaborator

tomatocat commented Jul 17, 2020 •
edited
Loading

Is your feature request related to a problem? Please describe.
The readme saying "step projcct" is not exactly informative

Describe the solution you'd like
README should migrate information over from the "project info" internal Google doc:

  • How to install dependencies and set up development environment
  • How to run development server
  • Deploying

It should also explain the project structure:

  • Folder structure
  • Languages and frameworks used
@tomatocat tomatocat self-assigned this Aug 2, 2020
@tomatocat
Copy link
Collaborator Author

Screenshots to use

Screenshot 2020-08-06 at 8 29 42 PM
Screenshot 2020-08-06 at 8 39 17 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomatocat tomatocat

Labels
priority: low type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tomatocat