Skip to content

Write README for the project #4

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
Open
lacasseio opened this issue Feb 11, 2025 · 1 comment
Open

Write README for the project #4

lacasseio opened this issue Feb 11, 2025 · 1 comment

Comments

@lacasseio
Copy link
Member

The README should contain information about contributing, the license, reference to samples, and documentation. Ideally, the README would be the base of the repository site.
@lacasseio
Copy link
Member Author

Mostly done, we should model the read me file more strongly so it can be applied to all projects (so far we have nokee-commons, nokee-multiplatform-publishing and nokee-companion). The plugin should be in the nokeebuild-plugins and used in the github template. We should mention samples, description, quick usage, documentation and license.

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
@lacasseio