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

README.md is too long and complicated #4

Open
pumpkinhasapatch opened this issue Sep 29, 2024 · 0 comments
Open

README.md is too long and complicated #4

pumpkinhasapatch opened this issue Sep 29, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@pumpkinhasapatch
Copy link
Owner

I have been trying to improve the translation project README document by reducing the amount of text people have to read and giving more detail to the important parts.

I feel like it's too long and confusing, and doesn't have any screenshots showing users what the translated game actually looks like. Some longer documentation and development notes could also be moved to the new project wiki.

GitHub has a guide on what should go in READMEs and what is better suited for wikis. For READMEs they say:

A README is often the first item a visitor will see when visiting your repository. README files typically include information on:

  • What the project does
  • Why the project is useful
  • How users can get started with the project
  • Where users can get help with your project
  • Who maintains and contributes to the project
@pumpkinhasapatch pumpkinhasapatch self-assigned this Sep 29, 2024
@pumpkinhasapatch pumpkinhasapatch added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 29, 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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant