Skip to content

Commit

Permalink
update & improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jothepro committed Jul 6, 2021
1 parent d1d5cb9 commit 4f8c44e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ The user is able to configure:

- What target platform to build for (Android, iOS, macOS, Windows, Linux)
- Which architectures to build for (x86, x86_64, armv7, armv8)
- Wether and how to package the resulting binaries (AAR, NuGet, XCFramework, Swift Package)
- Wether to build documentation for the library interfaces in each target language (Java, Objective-C, C++/CLI)
- Wether and how to package the resulting binaries (AAR, NuGet, XCFramework, Swift Package, Conan)
- Wether to build documentation for the library interfaces in each target language (C++, Java, Objective-C, C++/CLI)

For every target language, the following steps are executed (if requested by the user):
For every target language, the following steps are executed:

- **Configure Project & Install dependencies**: Runs `conan install` for each target architecture & target platform
- **Configure Project & Install Dependencies**: Runs `conan install` for each target architecture & target platform
to configure the CMake project and install all dependencies defined in the Conanfile.
- **Build**: Runs `conan build` for each target architecture & platform
- **Package**: Executes the platform specific packaging tasks. In some cases the packages will be built outside the
Expand Down Expand Up @@ -103,8 +103,11 @@ optional arguments:
--android [{x86_64,x86,armv8,armv7} ...]
list of architectures that the library should be built for android
--macos [{armv8,x86_64} ...]
list of architectures to build for macOS
--iphonesimulator [{armv8,x86_64} ...]
list of architectures to build for the iOS Simulator
--iphoneos [{armv8,armv7} ...]
list of architectures to build for iOS
--windows [{x86_64,x86,armv8,armv7} ...]
list of architectures to build for windows
--linux [{x86_64,x86,armv8,armv7} ...]
Expand All @@ -113,4 +116,5 @@ optional arguments:
--package [{xcframework,swiftpackage,conan,aar,nuget} ...]
which packages to create. Packages that cannot be created for the selected target platforms will be ignored.
--clean clean all build artifacts outside of the build folder, that this script may have created
```
12 changes: 6 additions & 6 deletions djinni_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -463,12 +463,15 @@ def main(self):
choices=list(Architecture),
help="list of architectures that the library should be built for android")
parser.add_argument('--macos', nargs='*', dest='macos_architectures', type=Architecture.from_string,
choices=list([Architecture.armv8, Architecture.x86_64]))
choices=list([Architecture.armv8, Architecture.x86_64]),
help='list of architectures to build for macOS')
parser.add_argument('--iphonesimulator', nargs='*', dest='iphonesimulator_architectures',
type=Architecture.from_string,
choices=list([Architecture.armv8, Architecture.x86_64]))
choices=list([Architecture.armv8, Architecture.x86_64]),
help='list of architectures to build for the iOS Simulator')
parser.add_argument('--iphoneos', nargs='*', dest='iphoneos_architectures', type=Architecture.from_string,
choices=list([Architecture.armv8, Architecture.armv7]))
choices=list([Architecture.armv8, Architecture.armv7]),
help='list of architectures to build for iOS')
parser.add_argument('--windows', nargs='*', dest='windows_architectures', type=Architecture.from_string,
choices=list(Architecture),
help='list of architectures to build for windows')
Expand All @@ -492,9 +495,6 @@ def main(self):
conan = Conan()

if arguments.android_architectures:
message_template = Template('Missing parameter: `$parameter` is required if building for Android!')
missing_parameter: bool = False

android_ndk = ''
try:
android_ndk = os.environ['ANDROID_NDK_HOME']
Expand Down

0 comments on commit 4f8c44e

Please sign in to comment.