issues with Markdown

Reviewed-on: #1

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased]
 
+## [v0.3.0]
+
 ### Added
 
 - TIM Cascade example
@@ -15,6 +17,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - `CountDownTimer` new function now expects an `impl Into<Hertz>` instead of `Hertz`
+- Primary repository now hosted on IRS external git: https://egit.irs.uni-stuttgart.de/rust/va108xx-hal
+- Relicensed as Apache-2.0
 
 ## [0.2.3]
 

Cargo.toml

@@ -1,12 +1,12 @@
 [package]
 name = "va108xx-hal"
-version = "0.2.3"
-authors = ["Robin Mueller <robin.mueller.m@gmail.com>"]
+version = "0.3.0"
+authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 edition = "2021"
 description = "HAL for the Vorago VA108xx family of microcontrollers"
-homepage = "https://github.com/robamu-org/va108xx-hal-rs"
-repository = "https://github.com/robamu-org/va108xx-hal-rs"
-license = "MIT OR Apache-2.0"
+homepage = "https://egit.irs.uni-stuttgart.de/rust/va108xx-hal"
+repository = "https://egit.irs.uni-stuttgart.de/rust/va108xx-hal"
+license = "Apache-2.0"
 keywords = ["no-std", "hal", "cortex-m", "vorago", "va108xx"]
 categories = ["embedded", "no-std", "hardware-support"]
 

LICENSE-MIT

@@ -1,25 +0,0 @@
-Copyright (c) 2021 Robin Mueller
-
-Permission is hereby granted, free of charge, to any
-person obtaining a copy of this software and associated
-documentation files (the "Software"), to deal in the
-Software without restriction, including without
-limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software
-is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice
-shall be included in all copies or substantial portions
-of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
-ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
-TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
-SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
-IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.

NOTICE

@@ -0,0 +1,3 @@
+Rust Hardware Abstraction Layer (HAL) crate for the Vorago VA108xx family of MCUs
+
+This software contains code developed at the University of Stuttgart.

README.md

@@ -5,7 +5,7 @@
 # HAL for the Vorago VA108xx MCU family
 
 This repository contains the **H**ardware **A**bstraction **L**ayer (HAL), which is an additional
-hardware abstraction on top of the [peripheral access API](https://egit.irs.uni-stuttgart.de/rust/va108xx-rs).
+hardware abstraction on top of the [peripheral access API](https://egit.irs.uni-stuttgart.de/rust/va108xx).
 
 It is the result of reading the datasheet for the device and encoding a type-safe layer over the
 raw PAC. This crate also implements traits specified by the
@@ -71,21 +71,17 @@ is contained within the
 
    ```toml
 	[dependencies]
-	cortex-m = "0.7.3"
-	cortex-m-rt = "0.7.0"
-	panic-halt = "0.2"
-	embedded-hal = "0.2.6"
+	cortex-m = "<Compatible Version>"
+	cortex-m-rt = "<Compatible Version>"
+	panic-halt = "<Compatible Version>"
+	embedded-hal = "<Compatible Version>"
 
 	[dependencies.va108xx-hal]
-	version = "0.2"
+	version = "<Most Recent Version>"
 	features = ["rt"]
    ```
 
-6. Build the application with
-
-	```sh
-	cargo build
-	```
+6. Build the application with `cargo build`
 
 7. Flashing the board might work differently for different boards and there is usually
    more than one way. You can find example instructions for the REB1 development board

automation/Dockerfile

@@ -0,0 +1,11 @@
+# Run the following commands from root directory to build and run locally
+# docker build -f automation/Dockerfile -t <NAME> .
+# docker run -it <NAME>
+FROM rust:latest
+RUN apt-get update
+RUN apt-get --yes upgrade
+# tzdata is a dependency, won't install otherwise
+ARG DEBIAN_FRONTEND=noninteractive
+
+RUN rustup target add thumbv6m-none-eabi && \
+	rustup component add rustfmt clippy

automation/Jenkinsfile

@@ -0,0 +1,50 @@
+pipeline {
+    agent any
+
+    stages {
+        stage('Clippy') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo clippy'
+            }
+        }
+        stage('Rustfmt') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo fmt'
+            }
+        }
+        stage('Check') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo check --target thumbv6m-none-eabi'
+            }
+        }
+        stage('Check Examples') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'cargo check --target thumbv6m-none-eabi --examples'
+            }
+        }
+    }
+}