Add supported platforms section to readme

This commit is contained in:
Ivan Matkov 2019-12-16 13:32:39 +03:00
Родитель a655d7d409
Коммит 8f757bc78e
1 изменённых файлов: 16 добавлений и 11 удалений

Просмотреть файл

@ -14,6 +14,12 @@ The easiest way to use PLCrashReporter is by using [AppCenter](https://appcenter
- Backtraces for all active threads are provided.
- Provides full register state for the crashed thread.
## Supported platforms
- iOS 8.0 and above
- macOS 10.7 and above
- tvOS 9.0 and above
## Decoding Crash Reports
Crash reports are output as protobuf-encoded messages, and may be decoded using the CrashReporter library or any Google Protobuf decoder.
@ -27,23 +33,23 @@ Future library releases may include built-in re-usable formatters, for outputtin
### Prerequisites
* A Mac
* Xcode 10 or above
* Doxygen to generate the documentation. See [the official Doxygen repository](https://github.com/doxygen/doxygen) for more information or use [Homebrew](https://brew.sh) to install it.
* GraphViz to generate the documentation. See [the official GraphViz website](https://www.graphviz.org/download/) for more information or use [Homebrew](https://brew.sh) to install it.
* `protobuf-c` to convert Protocol Buffer `.proto` files to C descriptor code. See [the official protobuf-c repository](https://github.com/protobuf-c/protobuf-c) for more information or use [Homebrew](https://brew.sh) to install it.
- A Mac running macOS compliant with Xcode requirements
- Xcode 10 or above
- Doxygen to generate the documentation. See [the official Doxygen repository](https://github.com/doxygen/doxygen) for more information or use [Homebrew](https://brew.sh) to install it.
- GraphViz to generate the documentation. See [the official GraphViz website](https://www.graphviz.org/download/) for more information or use [Homebrew](https://brew.sh) to install it.
- `protobuf-c` to convert Protocol Buffer `.proto` files to C descriptor code. See [the official protobuf-c repository](https://github.com/protobuf-c/protobuf-c) for more information or use [Homebrew](https://brew.sh) to install it.
### To build
* Open a new window for your Terminal.
* Go to PLCrashReporter's root folder and run
- Open a new window for your Terminal.
- Go to PLCrashReporter's root folder and run
```bash
xcodebuild BITCODE_GENERATION_MODE=bitcode OTHER_CFLAGS="-fembed-bitcode" -configuration Release -target 'Disk Image'
```
to create binaries for all platforms.
* Verify that your iOS and tvOS binaries have Bitcode enabled by running `otool -l build/Release-appletv/CrashReporter.framework/Versions/A/CrashReporter | grep __LLVM` (adjust the path to the binary as necessary). If you see some output, it means the binary is Bitcode enabled.
- Verify that your iOS and tvOS binaries have Bitcode enabled by running `otool -l build/Release-appletv/CrashReporter.framework/Versions/A/CrashReporter | grep __LLVM` (adjust the path to the binary as necessary). If you see some output, it means the binary is Bitcode enabled.
## Contributing
@ -59,11 +65,10 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
PLCrashReporter has a dependency on [Protocol Buffers implementation in C](https://github.com/protobuf-c/protobuf-c) as a git submodule. Use below command to clone PLCrashReporter repository or update the repository if you have already cloned it.
```
```bash
git clone --recursive https://github.com/microsoft/plcrashreporter.git
```
```
```bash
git submodule update --init --recursive
```