mitra 47a917767f Add CMake build instructions to README (#493)
Add CMake build instructions for macOS, Windows and Linux including
requirements and installation steps.

### Motivation:

Document how to build SwiftLog with CMake for projects that use mixed
build systems and need integration outside of Swift Package Manager.

### Modifications:

- Added a new “Building with CMake” section to `README.md`
- Documented minimum requirements:
  - Swift 6.1+
  - CMake 3.19+
  - Ninja 1.10+
- Added macOS build examples for both Xcode and Ninja generators
- Added Windows build instructions using Ninja
- Added install instructions and notes about shared vs. static builds
- Clarified that tests are not included in the CMake build and are still
managed through Swift Package Manager


### Result:

Users now have platform-specific guidance for building SwiftLog with
CMake on macOS, Windows and Linux.

Fixes #492
2026-08-12 13:49:22 +00:00
2026-06-24 13:42:03 +02:00
2024-11-14 17:01:02 +01:00
2024-10-30 13:17:15 +00:00
2019-02-24 13:51:38 +00:00

SwiftLog

This repository contains a logging API implementation for Swift. SwiftLog provides a unified, performant, and ergonomic logging API that can be adopted by libraries and applications across the Swift ecosystem.

Quick Start

The following snippet shows how to add SwiftLog to your Swift Package:

// swift-tools-version: 6.1
import PackageDescription

let package = Package(
    name: "YourApp",
    dependencies: [
        .package(url: "https://github.com/apple/swift-log", from: "1.6.0")
    ],
    targets: [
        .target(
            name: "YourApp",
            dependencies: [
                .product(name: "Logging", package: "swift-log")
            ]
        )
    ]
)

Then start logging:

import Logging

// Create a logger
let logger = Logger(label: "com.example.YourApp")

// Log at different levels
logger.info("Application started")
logger.warning("This is a warning")
logger.error("Something went wrong", metadata: ["error": "\(error)"])

// Add metadata for context
var requestLogger = logger
requestLogger[metadataKey: "request-id"] = "\(UUID())"
requestLogger.info("Processing request")

Available log handler backends

The community has built numerous specialized logging backends.

A great way to discover available log backend implementations is searching the Swift Package Index for the swift-log keyword.

Building with CMake

While Swift Package Manager (SPM) is the primary build system for development and testing, CMake build support is also available for integrated or mixed build environments if needed. Note that tests are not included in the CMake build, they are managed through Swift Package Manager with swift test.

S
Description
Mirror of github.com/apple/swift-log
Readme Apache-2.0
3.3 MiB
0 Stars 1 Watchers 0 Forks
Languages
Swift 97.5%
CMake 2.5%