Add README.md

This commit is contained in:
John 2025-06-01 14:30:21 +12:00
commit d669061130

30
README.md Normal file
View File

@ -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