From 38c28dfdb6de59c009f4b762db44eff6404ac5d7 Mon Sep 17 00:00:00 2001 From: Artem Sheremet Date: Thu, 1 Feb 2018 15:49:45 +0100 Subject: [PATCH] Add installation instructions (#12) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 0c89c90..aa4efdc 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,17 @@ [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org) [![Build Status](https://travis-ci.org/dasfoo/i2c.svg?branch=master)](https://travis-ci.org/dasfoo/i2c) [![Coverage Status](https://coveralls.io/repos/dasfoo/i2c/badge.svg?branch=master&service=github)](https://coveralls.io/github/dasfoo/i2c?branch=master) + +## Installation + +The library needs `i2c-dev.h` header file to compile, but the one that is +shipped with `linux-libc-dev` is not sufficient. You have to install the +"full" version of that header file, e.g. on +[Debian](https://packages.debian.org/stretch/all/libi2c-dev/filelist) or +[Ubuntu](https://packages.ubuntu.com/xenial/all/libi2c-dev/filelist) run: + +``` +# apt install libi2c-dev +``` + +Then use `go get -v github.com/dasfoo/i2c` normally.