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

Adding compiling instructions #203

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

Shideravan
Copy link

This may help newcomers on how to easily compile bsnes

README.md Outdated Show resolved Hide resolved
@jchv
Copy link
Contributor

jchv commented Aug 5, 2021

Looks OK overall. I think that it would be worth considering Msys2 as a recommended path forward, though, as it is probably the most complete MinGW distribution that is well-maintained.

@Screwtapello
Copy link
Contributor

Sorry it's taken me a while to look at this. I have some small and large concerns:

  • Why make "bsnes" bold?
  • There's already links to the git repo and Discord server under the "Links" heading, I'm not sure why you've duplicated them under the "Community" heading (and used a different Discord invite)
  • You use I. and II. as list items, but Markdown doesn't recognise Roman numerals so it breaks up the flow of the list. If you just make them regular numbers but with an extra 4 spaces of indent, they should be rendered properly.
  • You say "Download MinGW x64" and link to a page, but there's no actual download on that page. The page does link to a Downloads page, but that page contains nine options, none of which are titled "MinGW x64". There's a "MinGW-W64-builds" item, but it's out-of-date compared to the others and there's no way to tell whether it's too out-of-date for bsnes specifically.
  • Shouldn't the MinGW installer set any required environment variables? It seems like it would be very easy for people to get this wrong, or accidentally break other things in the process. The fewer bsnes-specific instructions we have to write, and the more we can rely on generic MinGW and MSYS instructions, the better.
  • Git isn't strictly-speaking required to build bsnes, so we shouldn't bring it up. If people want to use Git, there's whole websites dedicated to explaining where to get it and how to use it, so I'm happy to let those people take care of it.

@Shideravan
Copy link
Author

Ok, I'll take all that in consideration and will rewrite the text as soon as I can

* MSYS is being recomended as another good alternative (thanks for the suggestion @jchv
* bsnes isn't bold anymore
* I changed back the link in comunity section for the same invite link already it has (and now with a fancy new button)
* Changed the I and II to more usual markdown items
* Now all the text in the README is using default MD (then rather than "-----" we have hyrarchical subtitling
* The prerequisites now is separated and better explained. Note that I'm just pointing the websites for the user get his better suited version of the compilation suite
* Git is now optional. Further instructions is given about how to download the code manually without the need of Git.
* Now the text is no longer "windows only" with instructions that can be used in Linux and MacOS too.
It's linked with the bsnes license page
@Shideravan
Copy link
Author

Thanks for the feedback @Screwtapello and @jchv

@Shideravan Shideravan changed the title Adding windows compile instructions Adding compiling instructions Aug 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants