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

Better README #16

Open
gfgit opened this issue Aug 4, 2021 · 2 comments
Open

Better README #16

gfgit opened this issue Aug 4, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone
Be a better project!

Comments

@gfgit
Copy link
Owner

gfgit commented Aug 4, 2021

Use markdown for README.md.
I like those fancy readmes with icons, sections and links! But I'm currently focusing on code...
@gfgit gfgit added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Aug 4, 2021
@gfgit gfgit added this to the Be a better project! milestone Aug 4, 2021
@gfgit
Copy link
Owner Author

gfgit commented Aug 5, 2021

Maybe also create translations like README_it.md and link them in a language selection menu.

@gfgit
Copy link
Owner Author

gfgit commented Aug 10, 2021 •
edited
Loading

  • Mention it is cross-platform even though it has never been tested on Mac OS and poorly tested on Linux
  • Use more optimistic language in history
  • building a comunity is important
  • in contributions Mention that code must be in English (function names, classe, etc) and comments too or at least translated
  • Mention UI languages available in README
  • Explain how translations work and how to add new language translation to UI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
Be a better project!
Development

No branches or pull requests
1 participant
@gfgit