source icon indicating copy to clipboard operation
source copied to clipboard

Suggestion: Build instructions & others

Open sbrl opened this issue 8 years ago • 4 comments

I've found this and it looks cool, but your README doesn't tell me which operating systems are supported, or how to compile it from source.

Including these instructions & system requirements makes it easier for others to start using your program :smiley:

sbrl avatar Dec 23 '16 07:12 sbrl

Hi, {source} supports OS X and Windows. I have bought in the past {source} and it was installed via an installer so unfortunately I can't help you with building instructions.

Regards, Erik

beugelaar avatar Jan 16 '17 14:01 beugelaar

@beugelaar Ah right. Should the README say that only Windows and Mac are supported? I'm on linux, so if that's true that this won't work.

sbrl avatar Jan 16 '17 14:01 sbrl

Hi, yes I think you are right but I have looked further. The app is build with MacGap, a webkit wrapper. It is a XCode project and I have looked quickly but I think you have to build it on a OS X machine using MacGap.

First install MacGap:

gem install macgap

And then build the {source} app:

macgap build myapp // the {source app} i think it is in the public folder -> win/mac

Goodluck, Erik

beugelaar avatar Jan 16 '17 14:01 beugelaar

@beugelaar You have to build on a mac? I don't even know anyone with a mac, so I guess that's that for me using this project then!

Thanks for the help anyway :smiley:

Still, the author really should include build instructions in the README, because otherwise no-one will be able to figure out how to use it!

sbrl avatar Jan 16 '17 14:01 sbrl