Skip to content

Commit

Permalink
readme: lint to use standard Markdown syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
scivision committed Sep 1, 2023
1 parent 3ad22ec commit b2515ef
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
A CMake toolchain file for iOS (+ Catalyst), watchOS, tvOS and macOS development with full simulator support and toggleable options!

### NEW!

* Experimental Catalyst support (iOS on macOS)
* macOS support and experimental Apple Silicon support
* Deprecated options now removed.
* Builds now run on Github Actions

ios-cmake
=========
# ios-cmake

[![catalyst-jobs](https://github.com/leetal/ios-cmake/actions/workflows/catalyst.yml/badge.svg)](https://github.com/leetal/ios-cmake/actions/workflows/catalyst.yml)   [![combined-jobs](https://github.com/leetal/ios-cmake/actions/workflows/combined.yml/badge.svg)](https://github.com/leetal/ios-cmake/actions/workflows/combined.yml)   [![ios-jobs](https://github.com/leetal/ios-cmake/actions/workflows/ios.yml/badge.svg)](https://github.com/leetal/ios-cmake/actions/workflows/ios.yml)

[![macos-jobs](https://github.com/leetal/ios-cmake/actions/workflows/macos.yml/badge.svg)](https://github.com/leetal/ios-cmake/actions/workflows/macos.yml)   [![tvos-jobs](https://github.com/leetal/ios-cmake/actions/workflows/tvos.yml/badge.svg)](https://github.com/leetal/ios-cmake/actions/workflows/tvos.yml)   [![watchos-jobs](https://github.com/leetal/ios-cmake/actions/workflows/watchos.yml/badge.svg)](https://github.com/leetal/ios-cmake/actions/workflows/watchos.yml)

Tested with the following combinations:

* XCode 11.7
- iOS SDK 9.0 & 11.0
- watchOS SDK 5.0
- tvOS SDK 11.0
* iOS SDK 9.0 & 11.0
* watchOS SDK 5.0
* tvOS SDK 11.0
* XCode 12.5.1
- iOS SDK 12.0
- watchOS SDK 7.0
- macOS SDK 10.13
- iOS, watchOS, tvOS combined builds, mixed SDKs
* iOS SDK 12.0
* watchOS SDK 7.0
* macOS SDK 10.13
* iOS, watchOS, tvOS combined builds, mixed SDKs
* XCode 13.2
- Mac Catalyst SDK 13.0
- macOS SDK 11.0
* Mac Catalyst SDK 13.0
* macOS SDK 11.0

## Platform flag options (-DPLATFORM=_flag_)

Expand All @@ -49,6 +50,7 @@ Tested with the following combinations:
* _MAC_CATALYST_ARM64_ - to build iOS for Mac on Apple Silicon (Catalyst, arm64)

# Example usage

**_NOTE_: Change the `-DPLATFORM` to an applicable value if targeting another platform.**

```bash
Expand All @@ -59,12 +61,14 @@ cmake --build build --config Release

This will build the library for the given PLATFORM. In this case, iOS with the arm64 architecture.

### COMBINED Options
## COMBINED Options

The options called *COMBINED (OS64COMBINED, TVOSCOMBINED and WATCHOSCOMBINED) will build complete FAT-libraries for
the given platform. These FAT-libraries include slices for both device and simulator, making the distribution and
usage of the library much more simple!

Example:

```bash
cmake . -G Xcode -DCMAKE_TOOLCHAIN_FILE=../../ios.toolchain.cmake -DPLATFORM=OS64COMBINED
cmake --build . --config Release
Expand All @@ -76,6 +80,7 @@ cmake --install . --config Release # Necessary to build combined library
---

### Exposed Variables

`XCODE_VERSION` - Version number (not including Build version) of Xcode detected.

`SDK_VERSION` - Version of SDK being used.
Expand All @@ -85,6 +90,7 @@ cmake --install . --config Release # Necessary to build combined library
`APPLE_TARGET_TRIPLE` - Used by autoconf build systems.

### Additional Options

`-DENABLE_BITCODE=(BOOL)` - Disabled by default, specify TRUE or 1 to enable bitcode

`-DENABLE_ARC=(BOOL)` - Enabled by default, specify FALSE or 0 to disable ARC
Expand Down

0 comments on commit b2515ef

Please sign in to comment.