From ae57163fd68a5aa737feba6985c637622e31f31d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leonel=20Mu=C3=B1oz?= Date: Mon, 27 May 2019 15:11:01 -0400 Subject: [PATCH] Fix readme --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 385fe7d..49dc1af 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,12 @@ ## Dev -Download and install **libserialport** dependency ([instructions](https://sigrok.org/wiki/Libserialport)) ```git clone git://sigrok.org/libserialport``` +Download and install **libserialport** dependency ([instructions](https://sigrok.org/wiki/Libserialport)) `git clone git://sigrok.org/libserialport` + +If you´re using macos and Homebrew, you can install with `brew install libserialport` ### Drivers (This depends on the serial adapter you have) + - Driver USB Serial **Chipset CH340** for Windows: - Driver USB Serial **Chipset CH340** for macOS: - Driver USB Serial **Chipset Prolific** for macOS: @@ -14,23 +17,23 @@ Download and install **libserialport** dependency ([instructions](https://sigrok - Visual Studio 2017 + c++ utilities. - [msys2 - mingw-w64](http://www.msys2.org/) follow the instructions in the web site. - - Install mingw tolchain - - 32bits: ```pacman -S mingw-w64-i686-toolchain``` - - 64bits: ```pacman -S mingw-w64-x86_64-toolchain``` - - Install mingw cmocka - - 32bits: ```pacman -S mingw32/mingw-w64-i686-cmocka``` - - 64bits: ```pacman -S mingw64/mingw-w64-x86_64-cmocka``` + - Install mingw tolchain + - 32bits: `pacman -S mingw-w64-i686-toolchain` + - 64bits: `pacman -S mingw-w64-x86_64-toolchain` + - Install mingw cmocka + - 32bits: `pacman -S mingw32/mingw-w64-i686-cmocka` + - 64bits: `pacman -S mingw64/mingw-w64-x86_64-cmocka` - Swig (you can use [Chocolatey](https://chocolatey.org/)) ### macOS This instructions asume you have [homebrew](https://brew.sh/) installed. -- ```brew install automake``` -- ```brew install autoconf``` -- ```brew install libtool``` -- ```brew install swig``` -- ```brew install cmocka``` +- `brew install automake` +- `brew install autoconf` +- `brew install libtool` +- `brew install swig` +- `brew install cmocka` ### Unix @@ -41,8 +44,7 @@ This instructions asume you have [homebrew](https://brew.sh/) installed. - swig - cmocka - -## Run / Examples & Installation +### Run / Examples & Installation #### Build @@ -69,6 +71,7 @@ cp build/transbank.dylib /usr/local/lib ``` #### Test + The project now uses [cmocka](https://cmocka.org) to run unit test. Once you have **cmocka** installed on yor machine, you can simply do: