Add more better readme #75
Conversation
petitlapin
left a comment
petitlapin
left a comment
There was a problem hiding this comment.
Thank you for the PR.
It seems there are commits from the previous PR, is it possible to remove them so we can focus only on the README in this PR?
README.md
Outdated
| ------------- | ||
|
|
||
| Copyright (c) 2023 | ||
| Johnny Jazeix <jazeix@gmail.com>: port to SDL2 + android + cmake |
There was a problem hiding this comment.
I would remove the email here and below, I don't want to receive mails directly and for Dominique, I'm assuming the email is not read anymore
README.md
Outdated
|
|
||
| Copyright (c) 2006 | ||
| Dominique Roux-Serret: roux-serret@ifrance.com : design & programming & graphics & website. | ||
| Maf464 : site= http://maf464.free.fr : musics |
There was a problem hiding this comment.
the website does not contain anything anymore, let's remove it too
README.md
Outdated
| ## Building | ||
| To build this game you have to clone repository using `git clone https://github.com/petitlapin/Li-Ri.git`, install SDL 2, and execute: | ||
| ``` | ||
| cd Li-Ri | ||
| mkdir build | ||
| cd build | ||
| cmake .. | ||
| make | ||
| ``` |
There was a problem hiding this comment.
there is a section to build in the INSTALL file, can you reuse it as it has more information?
Or keep this information on the INSTALL and have a text like: "Information on how to compile Li-Ri is available in the INSTALL file"
README.md
Outdated
| @@ -1,23 +1,47 @@ | |||
| # Li-Ri is a G.P.L. arcade game about toy wooden train | |||
There was a problem hiding this comment.
we usually write GPL, not G.P.L
README.md
Outdated
| - Android support | ||
| - CMake support |
There was a problem hiding this comment.
These are technical information, not "user" features (the user does not care about it and Android support has already been announced above)
Thanks petitlapin Co-authored-by: Johnny Jazeix <be__good@hotmail.com>
Corrected formatting and license references in README.
|
Fixed |
petitlapin
left a comment
petitlapin
left a comment
There was a problem hiding this comment.
I added a few comments.
You should not work directly on the main branch, the main branch of a fork should always be synchronized with the upstream main.
I didn't find any better article, but this explains how to work from a fork: https://dev.to/torirodgers/a-beginners-guide-to-forking-and-syncing-github-repositories-4kdk
Regarding you main branch, I would suggest to rebase against the upstream main branch: https://gitcheatsheet.dev/docs/advanced/interactive-rebase/
Ideally, in your fork, you want to delete all the previous commit related to the previous PR and squash the README commits into one and force push. Then be sure to always work from a branch and once a PR is merged, update your main with upstream main.
Co-authored-by: Johnny Jazeix <be__good@hotmail.com>
Co-authored-by: Johnny Jazeix <be__good@hotmail.com>
|
Fixed |
2 participants
No description provided.