ankitects
UPDATE(docs): Add build dependencies and instructions for building / running the launcher
This is mainly for people like me that experience problems like this one: https://github.com/ankitects/anki/pull/4327. I was confused because I thought ankis build script auto downloaded the dependency for me; turns out, I had to apt install it. I'm pretty sure anki does download several build dependencies already, so didn't expect that that wasn't the case here as well.
The building and executing part was quite easy to understand once the dependency issue was solved. I prefer to have actual examples in the docs nonetheless.
This is linux focused (possible even x86_64 focused) as I have no other OS and architecture to test this on.
@abdnh Please especially check the windows and macos commands / instructions; I know that the Linux instructions and commands are correct because I tried them; but I have no way of testing on a windows or macos machine.
I had to disable code signing on Windows/MacOS to build, but I don't think we need to mention these details. Users advanced enough to build the launcher will figure that out.
On Mac, NODMG=1 will skip the slow bundling/code signing, and on Windows set NOCOMP=1 will skip code signing and compression. It might be too optimistic to assume they'll read the build script ^_^;
Dae, are you saying I should add this to the instructions? If it's in the build script then it's done automatically for the dev, right? I'd need a pointer on where / after which instruction to add this info and whether it's optional or necessary to do that.
If it's in the build script then it's done automatically for the dev, right? I'd need a pointer on where / after which instruction to add this info and whether it's optional or necessary to do that.
NODMG/NOCOMP are environment variables that need to be set to 1 before running the build script (required for anyone other than dae).
Thank you dae and abdnh! I made some changes.
I have implemented the env var change as text in https://github.com/ankitects/anki/pull/4380/commits/d040148b866896fa12985df0752cd8d1fe5ea86e and then in the table in https://github.com/ankitects/anki/pull/4380/commits/efb1b1a4bcc452438d6d084144356d245f0a3ca3. If you prefer the text one, the last table commit can be reverted. Both commits can stand on their own, they aren't dependent on each other. I'll let you decide.