Merge pull request #6 from jessebraham/travis

Add Travis configuration to verify PAC can be generated

Author: icewind1991

.travis.yml

@@ -0,0 +1,20 @@
+language: rust
+rust:
+  - nightly
+cache: cargo
+dist: "trusty"
+before_install:
+  - python --version
+  - pyenv install 3.6.3
+  - pyenv global 3.6.3
+
+matrix:
+  fast_finish: true
+
+install:
+  - rustup component add rustfmt
+  - pip3 install --upgrade --user svdtools
+  - cargo install form --force
+  - cargo install --git https://github.com/rust-embedded/svd2rust svd2rust --force
+
+script: make clean patch generate form fmt

README.md

@@ -1,9 +1,14 @@
 # esp8266
 
-A peripheral access crate the ESP8266. See the svd2rust repo for more infomation on how to use this crate. Espressif do not provide an SVD for the esp8266, so the svd used in this project has been generated from the C header documentation via the [idf2svd](https://github.com/icewind1991/idf2svd/tree/esp8266) tool.
+[![Build Status](https://travis-ci.com/esp-rs/esp8266.svg?branch=master)](https://travis-ci.com/esp-rs/esp8266)
+![crates.io](https://img.shields.io/crates/v/esp8266.svg)
+
+A peripheral access crate the ESP8266. See the [`svd2rust` repo](https://github.com/rust-embedded/svd2rust) for more infomation on how to use this crate. Espressif do not provide an SVD for the ESP8266, so the SVD used in this project has been generated from the C header documentation via the [idf2svd](https://github.com/MabezDev/idf2svd) tool.
 
 Join in on the discussion: https://matrix.to/#/#esp-rs:matrix.org!
 
+## [`Documentation`](https://docs.rs/esp8266/latest/esp8266/)
+
 ## Building
 
 Required dependencies:
@@ -20,7 +25,7 @@ $ make
 
 The base svd file created from `idf2svd` should **not** be edited. Instead the svd is manipulated through the svdtools patching tool.
 
-See [svd](https://github.com/stm32-rs/svdtools) and [stm32-rs yaml format](https://github.com/stm32-rs/stm32-rs#device-and-peripheral-yaml-format) for more infomation on the patching format
+See [svdtools](https://github.com/stm32-rs/svdtools) and [Device and Peripheral YAML Format](https://github.com/stm32-rs/svdtools#device-and-peripheral-yaml-format) for more infomation on patching.
 
 ## License