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

Write a better README, that guides newcomers into the project. #32

Open
jlnunez89 opened this issue Dec 18, 2019 · 1 comment
Open

Write a better README, that guides newcomers into the project. #32

jlnunez89 opened this issue Dec 18, 2019 · 1 comment
Labels
debt Technical or Documentation debt.

Comments

@jlnunez89
Copy link
Owner

It's currently too hard to figure out the project structure by just skimming the repo.

It's better and easier for newcomers if the README actually guides them though the process of running the server locally so that they get familiar with the structure and frameworks available.
@jlnunez89 jlnunez89 added the debt Technical or Documentation debt. label Dec 18, 2019
@jlnunez89
Copy link
Owner Author

improved with #39 #38, still not done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
debt Technical or Documentation debt.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jlnunez89