Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
leonlynch committed Dec 18, 2021
1 parent 81b084e commit f2c785d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Currently this library implements parsing/decryption and encoding/encryption
of TR-31 format version A, B, C, and D. Various helper functions are also
available to stringify TR-31 header attributes.

Dependencies
============

* C11 compiler such as GCC or Clang
* CMake
* TR-31 library requires MbedTLS (preferred), or OpenSSL
* TR-31 tool requires argp (either via Glibc or a standalone implementation)

Build
=====

Expand Down Expand Up @@ -96,6 +104,24 @@ cmake --build build &&
cmake --build build --target package
```

MacOS / Windows
===============

On platforms such as MacOS or Windows where static linking is desirable and
dependencies such as MbedTLS or argp may be unavailable, the `FETCH_MBEDTLS`
and `FETCH_ARGP` options can be specified when generating the build system.

In addition, MacOS universal binaries can be built by specifying the desired
architectures using the `CMAKE_OSX_ARCHITECTURES` option.

This is an example of how a self-contained, static, universal binary can be
built from scratch for MacOS:
```
rm -Rf build &&
cmake -B build -DCMAKE_BUILD_TYPE="RelWithDebInfo" -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" -DFETCH_MBEDTLS=YES -DFETCH_ARGP=YES &&
cmake --build build
```

Usage:
======

Expand Down

0 comments on commit f2c785d

Please sign in to comment.