[Enhancement]: Provide compilation instructions

[ashquarky]

Checked Existing

• I have checked the repository for duplicate issues.

What enhancement would you like to see?

Inkay's README or other documentation should talk about how to compile it; and remind users about their obligations under the GPL for any modified binaries they might produce.

Any other details to share? (OPTIONAL)

See #37

[Cart1416]

please tell how to compile I've been trying for 4 hours and still can't do it, I can't find /opt/devkitpro/wums/share/libkernel.ld

[JouriR]

@Cart1416 Here are the steps I follow to build locally:

1. First please make sure you have Docker installed on your machine (https://docs.docker.com/get-docker/).
2. Navigate to the directory where you have the Inkay source code.
3. Run docker build . -t builder to build the Inkay-builder docker image.
4. Then run docker run --rm -v ${PWD}:/app -w /app builder to build Inkay using the image you just created.

And that's it! You should now have a Inkay-pretendo.elf & Inkay-pretendo.wps file in your directory.

[Cart1416]

@JouriR I got it to work, I followed instructions like that but I had to copy the source code to the app directory

[JouriR]

@Cart1416 Great! Glad I could help :)