README.md

Fuchsia RTC Driver Repository
=======================================

This repository is a based on a template repository which will be adopted
automatically by OOT driver repositories.

Template repository is located in: https://fuchsia.googlesource.com/template/driver/

Getting Started
=======================================

To perform an initial bootstrap, execute the following:

1. In a terminal, clone the repository:

   ```posix-terminal
   git clone https://fuchsia.googlesource.com/drivers/rtc/nxp/pcf8563
   ```

1. Change to that directory:

   ```posix-terminal
   cd pcf8563
   ```

1. Fetch all git submodules:

   ```posix-terminal
   git submodule init && git submodule update --recursive
   ```

1. Bootstrap the build environment:

   ```posix-terminal
   scripts/bootstrap.sh
   ```

1. Fetch and build the SDK:

   ```posix-terminal
   tools/bazel build @fuchsia_sdk//:fuchsia_toolchain_sdk
   ```

See the [getting started](https://fuchsia.dev/fuchsia-src/get-started/sdk/get-started-with-driver)
guide for more info.

Building And Testing Driver
=======================================

The Fuchsia driver package can be built locally with:

```posix-terminal
tools/bazel build src/drivers/pcf8563:pkg
```

Run the full test-suite with:

```posix-terminal
tools/bazel test :tests_qemu
```

Run only the pcf8563 driver tests with:

```posix-terminal
tools/bazel test src/drivers/pcf8563:test_x64
```