va108xx/README.md

[![Crates.io](https://img.shields.io/crates/v/va108xx)](https://crates.io/crates/va108xx)
[![build](https://github.com/robamu-org/va108xx-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/robamu-org/va108xx-rs/actions/workflows/ci.yml)
[![docs.rs](https://img.shields.io/docsrs/va108xx)](https://docs.rs/va108xx)

# PAC for the Vorago VA108xx microcontroller family

This repository contains the Peripheral Access Crate (PAC) for
Voragos VA108xx series of Cortex-M0 based microcontrollers.

The crate was generated using [`svd2rust`](https://github.com/rust-embedded/svd2rust).

## Usage

To use this crate, add this to your `Cargo.toml`

```toml
[dependencies.va108xx]
version = "0.1"
features = ["rt"]
```

The `rt` feature is optional and recommended. It brings in support for `cortex-m-rt`.

For full details on the autgenerated API, please see the
[svd2rust documentation](https://docs.rs/svd2rust/0.19.0/svd2rust/#peripheral-api).

## Regenerating the PAC

The base file used by `svd2rust` is generated using the `svdtools` package and a
YAML patch file. You can create the patched file by running this command after installing
the Python [`svdtools` package](https://github.com/stm32-rs/svdtools):

```sh
cd svd
svd patch va108xx-patch.yml
```

After that, you can regenerate the PAC by running the `gen-helper.sh` helper script.
added crates IO badge 2021-11-06 01:37:29 +01:00			`[![Crates.io](https://img.shields.io/crates/v/va108xx)](https://crates.io/crates/va108xx)`
added docs and build badge 2021-11-02 10:41:22 +01:00			`[![build](https://github.com/robamu-org/va108xx-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/robamu-org/va108xx-rs/actions/workflows/ci.yml)`
			`[![docs.rs](https://img.shields.io/docsrs/va108xx)](https://docs.rs/va108xx)`

added basic CI file 2021-11-01 23:41:06 +01:00			`# PAC for the Vorago VA108xx microcontroller family`

typo 2021-11-02 00:07:57 +01:00			`This repository contains the Peripheral Access Crate (PAC) for`
added basic CI file 2021-11-01 23:41:06 +01:00			`Voragos VA108xx series of Cortex-M0 based microcontrollers.`

update README 2021-11-01 23:55:24 +01:00			The crate was generated using [`svd2rust`](https://github.com/rust-embedded/svd2rust).
Updated SVD file handling and README SVD base file is now created using the svdtools package and a YAML file. Update README with usage information as well. This PR also adds new fields for the peripheral clock enable register in the SVD file 2021-11-04 22:34:12 +01:00
			`## Usage`

			To use this crate, add this to your `Cargo.toml`

			```toml
			`[dependencies.va108xx]`
update README 2021-11-09 18:21:22 +01:00			`version = "0.1"`
Updated SVD file handling and README SVD base file is now created using the svdtools package and a YAML file. Update README with usage information as well. This PR also adds new fields for the peripheral clock enable register in the SVD file 2021-11-04 22:34:12 +01:00			`features = ["rt"]`
			```

			The `rt` feature is optional and recommended. It brings in support for `cortex-m-rt`.

			`For full details on the autgenerated API, please see the`
			`[svd2rust documentation](https://docs.rs/svd2rust/0.19.0/svd2rust/#peripheral-api).`

			`## Regenerating the PAC`

			The base file used by `svd2rust` is generated using the `svdtools` package and a
			`YAML patch file. You can create the patched file by running this command after installing`
			the Python [`svdtools` package](https://github.com/stm32-rs/svdtools):

			```sh
			`cd svd`
			`svd patch va108xx-patch.yml`
			```

			After that, you can regenerate the PAC by running the `gen-helper.sh` helper script.