commit d669061130e6c07abf4bf840a20c29aa824a3a00 Author: John Date: Sun Jun 1 14:30:21 2025 +1200 Add README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe73fce --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Dropshell Build + +## Installation + +First install dropshell-tool, then: +``` +dropshell-tool install dropshell-build +``` + +If you wish to use local toolchain (rather than docker): +``` +install_dropshell_build_requirements +``` + +## Use + +``` +dropshell-build [-r] [-m] DIRECTORY +``` + +where `DIRECTORY` is the path to your `CMakeLists.txt`, `-r` specifies release version (rather than debug), and `-m` builds for multiple architectures (rather than just the host arch). + + +## Notes + +- Cross-Builds with musl (from https://musl.cc ) +- Uses DIRECTORY/CMakeLists.txt +- Temporary build files go in DIRECTORY/build +- Output files (executables) go in DIRECTORY/output +- Will use local toolchain if it exits, otherwise docker