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

Edit readme file #6

Open
kkiermasz opened this issue Nov 1, 2020 · 0 comments
Open

Edit readme file #6

kkiermasz opened this issue Nov 1, 2020 · 0 comments

Comments

@kkiermasz
Copy link
Owner

The readme file should be built according to the following scheme:

  • A header saying what the project is, why it was created and what it offers. It should also include a picture showing whether the tests pass
  • Description of the most important functionalities, the main intention of using the framework
  • Link to documentation
  • Demo project link
  • Project requirements
  • How to add Neron to your application
  • License details and link to the LICENSE file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kkiermasz