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.

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

Add a README to the project #14

Open
lucas-yotsui opened this issue Jul 16, 2024 · 0 comments
Open

Add a README to the project #14

lucas-yotsui opened this issue Jul 16, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lucas-yotsui
Copy link
Owner

The project must have a README file to describe it for users and potential collaborators. In this file there must be some important information regarding the project. Here are some of the vital information that must be present in this file, divided by target:

All visitors of this project

  • My own contact info, like LinkedIn and so on (must do some networking am I right).
  • Ask them to star the repo of course
  • Links to the MicroZig repo (they were really helpful with my doubts and a big inspiration to multiple parts of this project).

Possible collaborators

  • Code style guidelines
  • Process on how to collaborate (create issues, pull requests, etc).

Users of this project

  • Link to the project's Wiki.
@lucas-yotsui lucas-yotsui added the documentation Improvements or additions to documentation label Jul 16, 2024
@lucas-yotsui lucas-yotsui self-assigned this Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Not Started
Development

No branches or pull requests

1 participant