viz-swift-lib/README.md

1.1 KiB

viz-swift-lib

VIZ library for Swift.

Installation

Using the Swift package manager:

In your Package.swift just add:

dependencies: [
    .package(url: "https://github.com/viz-blockchain/viz-swift-lib.git", .branch("master"))
]

and run swift package update. Now you can import VIZ in your Swift project.

Running tests

To run all tests simply run swift test, this will run both the unit- and integration-tests. To run them separately use the --filter flag, e.g. swift test --filter IntegrationTests

Developing

Development of the library is best done with Xcode, to generate a .xcodeproj you need to run swift package generate-xcodeproj.

To enable test coverage display go "Scheme > Manage Schemes..." menu item and edit the "viz-swift-lib" scheme, select the Test configuration and under the Options tab enable "Gather coverage for some targets" and add the viz-swift-lib target.

After adding adding more unit tests the swift test --generate-linuxmain command has to be run and the XCTestManifest changes committed for the tests to be run on Linux.