Skip to content

Commit

Permalink
Merge pull request #25 from TransbankDevelopers/chore/readme
Browse files Browse the repository at this point in the history
Improve readme
  • Loading branch information
Alfredo Fiebig authored Jun 18, 2019
2 parents 0b97dda + ae57163 commit 75509b5
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <http://www.wch.cn/download/CH341SER_EXE.html>
- Driver USB Serial **Chipset CH340** for macOS: <https://blog.sengotta.net/signed-mac-os-driver-for-winchiphead-ch340-serial-bridge/>
- Driver USB Serial **Chipset Prolific** for macOS: <http://www.prolific.com.tw/US/ShowProduct.aspx?p_id=229&pcid=41>
Expand All @@ -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

Expand All @@ -41,8 +44,7 @@ This instructions asume you have [homebrew](https://brew.sh/) installed.
- swig
- cmocka


## Run / Examples & Installation
### Run / Examples & Installation

#### Build

Expand All @@ -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:

Expand Down

0 comments on commit 75509b5

Please sign in to comment.