[DOCS] Improve README.md
KendallDoesCoding opened this issue · 15 comments
There are a bunch of grammar issues, and I feel like it doesn't state exactly what this project is so I would like if someone would help me improve the README.md but adding sections, improving grammar, etc.
can I work on this?
can I work on this?
sure!
Are there any contributing guidelines that need to be included?
Are there any contributing guidelines that need to be included?
No, I will do it myself once #3 is done.
ok
Hi! There are minor grammatical errors that can be fixed and the ReadMe can become a bit more interesting!
Also, it would be awesome if you can post screenshots or maybe some pictures that could describe the game if that is possible :)
Hi, can you work on the grammar errors. Yeah, I will add a screen recording and a few snaps in a bit of the game, thanks for your suggestion.
…
On Sat, 20 Aug 2022 at 12:16, Krupali Trivedi @.***> wrote: Hi! There are minor grammatical errors that can be fixed and the ReadMe can become a bit more interesting! Also, it would be awesome if you can post screenshots or maybe some pictures that could describe the game if that is possible :) — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AUGJUTNTANQD4JXHXFVLE4TV2B5M5ANCNFSM56H5HH5Q . You are receiving this because you authored the thread.Message ID: </issues/1/1221245211@ github.com>
Hi! I would love to work on the editing :) thank you!
Will close this issue after I add the screenshots.
@krupalitrivedi I tried to include a example video but it's not showing like I see in other repos
Commits:
@KendallDoesCoding When i tried putting the video through 'drag and drop' method, I was able to see it, but when I tried putting it through internal linking, it isn't working. Working on the same rn and will let you know as soon as possible!
@KendallDoesCoding When i tried putting the video through 'drag and drop' method, I was able to see it, but when I tried putting it through internal linking, it isn't working. Working on the same rn and will let you know as soon as possible!
I think I've made a issue in the README embedding it or the file format is wrong, mkv is surely wrong, so I made it mov, maybe it needs to be mp4?
@KendallDoesCoding When i tried putting the video through 'drag and drop' method, I was able to see it, but when I tried putting it through internal linking, it isn't working. Working on the same rn and will let you know as soon as possible!
I think I've made a issue in the README embedding it or the file format is wrong, mkv is surely wrong, so I made it mov, maybe it needs to be mp4?
@KendallDoesCoding no no mov is fine, i was able to embed it into your readme! I'm trying to figure out the problem with internal problem
May need to trim the video down a little bit, but for now it's fine.. Thanks @krupalitrivedi and @athulmekkoth for helping improve the README :)))