Skip to content

Create Readme #18

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.

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

Open
jo-al-ra opened this issue Jul 27, 2022 · 0 comments · Fixed by #37
Open

Create Readme #18

jo-al-ra opened this issue Jul 27, 2022 · 0 comments · Fixed by #37
Assignees
Labels
enhancement New feature or request

Comments

@jo-al-ra
Copy link
Owner

Is your feature request related to a problem? Please describe.
As an outsider, I want to be able to work myself into the project and all its components. The used components, folder structure and hints to start them are missing.

Describe the solution you'd like
Create a README with sections covering the following topics:

  • General Info
  • demo / screenshots
  • Components Overview
  • getting started / installation guide

Describe alternatives you've considered
Consider looking at README templates

Additional context
Add any other context or screenshots about the feature request here.

@jo-al-ra jo-al-ra added the enhancement New feature or request label Jul 27, 2022
@jo-al-ra jo-al-ra self-assigned this Jul 27, 2022
@jo-al-ra jo-al-ra linked a pull request Aug 13, 2022 that will close this issue
@jo-al-ra jo-al-ra reopened this Aug 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant