search

cebix / macemu

Basilisk II and SheepShaver Macintosh emulators
1.38k stars 288 forks source link

Please include compilation instructions in your README.MD #182

Open KI5JYD opened 5 years ago

KI5JYD commented 5 years ago

Please, be a bit helpful because I had to go onto AskUbuntu just to figure this out.

Your README.MD is blank, @cebix

screenshot

Compilation instructions are a must when offering software. People shouldn't have to Google around for hours figuring how to compile software, what dependencies are needed for compiling and such.

I love open source software, but please consider your users when they are trying to use it. We don't know what libraries you used to compile, we don't need to parse the source on how to compile it. We need step-by-step instructions on how to get it done.

Here is a good example on a well-written README.MD: https://github.com/AntiMicro/antimicro/blob/master/README.md

All the things you need to know are there. What dependencies are needed to compile. What commands to type to compile.

aviallon commented 5 years ago

I was just going to say that one !

wmakley commented 5 years ago

Desperate here as well, cannot get it to work on anything. :(

RonaldPR commented 5 years ago

Better ask questions about compiling in Emaculation forum: https://www.emaculation.com/forum/ Various builds (OSX/macOS, Windows, and Linux) can also be downloaded from topics there.

Compiling instructions (partly outdated) can be found in Emaculation wiki: https://www.emaculation.com/doku.php/compiling_sheepshaver_basilisk

Op 7 jan. 2019, om 15:18 heeft William Makley notifications@github.com het volgende geschreven:

Desperate here as well, cannot get it to work on anything. :(

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

rickyzhang82 commented 5 years ago

Either check out the great stuffs from emaculation or the wiki here.

I contributed some technical doc in Github wiki. You are welcome to add.

wmakley commented 5 years ago

Thanks!

On Mon, Jan 7, 2019 at 1:03 PM Ricky Zhang notifications@github.com wrote:

Either check out the grate stuffs from emaculation https://www.emaculation.com/forum/ or the wiki here https://github.com/cebix/macemu/wiki/Basilisk-II-Compilation-Guide.

I contributed some technical doc in Github wiki. You are welcome to add.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/cebix/macemu/issues/182#issuecomment-452025002, or mute the thread https://github.com/notifications/unsubscribe-auth/AAfYjSse4u_wNor1YJlrhRVsewlniKPoks5vA4vYgaJpZM4YxaFJ .

-- William Makley Lead Developer | Tortus wmakley@tortus.com | http://tortus.com/ | (413) 749-5999

asvitkine commented 5 years ago

If anyone wants to send a PR adding those build instructions into a README.md file, happy to merge them.

On Tue, Jan 8, 2019 at 9:33 AM William Makley notifications@github.com wrote:

Thanks!

On Mon, Jan 7, 2019 at 1:03 PM Ricky Zhang notifications@github.com wrote:

Either check out the grate stuffs from emaculation https://www.emaculation.com/forum/ or the wiki here https://github.com/cebix/macemu/wiki/Basilisk-II-Compilation-Guide.

I contributed some technical doc in Github wiki. You are welcome to add.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/cebix/macemu/issues/182#issuecomment-452025002, or mute the thread < https://github.com/notifications/unsubscribe-auth/AAfYjSse4u_wNor1YJlrhRVsewlniKPoks5vA4vYgaJpZM4YxaFJ

.

-- William Makley Lead Developer | Tortus wmakley@tortus.com | http://tortus.com/ | (413) 749-5999

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/cebix/macemu/issues/182#issuecomment-452319060, or mute the thread https://github.com/notifications/unsubscribe-auth/AABE8GCsAsRUpHdRRpRrx1dLrHsB3P6kks5vBKxWgaJpZM4YxaFJ .

ianfixes commented 5 years ago

I would like to take on this work, setting up the following (at minimum):

This would require some involvement from the repo owner, @cebix ... I get the sense that he is not involved very much. Where do I find the group who oversees this repo?

rickyzhang82 commented 5 years ago

A Chinese proverb goes "A journey of a thousand miles begins with a single step". A PR with a modern README.md with build instruction is that single step before you losing all momentum.

BTW, Travis CI is there. But it requires the repo owner to enable it. Now it still points to my repos. It didn't match the commit of master branch. It only builds BII.

ianfixes commented 5 years ago

The "single step" needed here is for someone to claim ownership of the repo. It makes no sense for me to submit a PR against a repo that already has PRs over 5 years old, and one that can't modify its own CI settings. Is anyone in contact with the owner?

ianfixes commented 5 years ago

Nevermind, I decided to take that step myself. I've created a new organization to manage this development (@cebix has been invited) and split the repo into the 3 projects it contains:

I'd be glad to continue this discussion here: https://github.com/emaculation/BasiliskII/issues/1

rickyzhang82 commented 5 years ago

There are many reasons why PR has not been merged for years. But I don't think you should blame the maintainer for that if you read those PR carefully.

I merged upstream master branch to my travis CI branch. The green pass button should match what we have now. But this is not ideal.

In any case, good luck and best wishes. If you don't like it, fork it.

ianfixes commented 5 years ago

@rickyzhang82 and @asvitkine could you join the discussion at https://github.com/kanjitalk755/macemu/issues/14 to help us determine how best to combine the work that has been done in all these personal forks?