Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grodansparadis committed Mar 17, 2020
1 parent fdb261b commit 9b88cfb
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,32 @@
# vscp-helper-lib

Helper functionality for VSCP packed in a library
Helper functionality packed in a shared library for [VSCP](https://www.vscp.org)

<img src="https://vscp.org/images/logo.png" width="100">

**Available for**: Linux, Windows

Full documentation is [here](https://grodansparadis.gitbooks.io/the-vscp-helper-library/).
Full documentation is [here](https://docs.vscp.org/#vscphelper).

Wrapper for Python is [here](https://github.com/grodansparadis/pyvscp)

Wrapper for node.js is [here](https://github.com/grodansparadis/node-vscp-helper).

## How to install on Linux

> sudo dpkg -i libvscphelper14-14.0.0.deb
Download the Debian install file for your system in the release section of this repository. If you just want to use a binaray that depend on this library there is no need to download the dev version. If you expect to use the library for development you should download and install both.

```bash
> sudo apt install ./libvscphelper14_14.0.0-1_amd64.deb
> ./libvscphelper14-dev_14.0.0-1_amd64.deb
```

or

```bash
> sudo dpkg -i ./libvscphelper14_14.0.0-1_amd64.deb
> sudo dpkg -i ./libvscphelper14-dev_14.0.0-1_amd64.deb
```

## How to install on Windows
Install using the windows installation script available in the release section och this repository.
Expand All @@ -27,4 +42,6 @@ make install
```

## How to build on Windows
tbd# lynx-node-red
tbd


5 changes: 3 additions & 2 deletions build_debian_package.sh
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#!/bin/sh

# arg1 - platform
# ---------------
# i386 ununtu/debian ./build_debian_package.sh i386 10
# amd64, ununtu/debian ./build_debian_package.sh amd64 10
# amd64 ununtu/debian ./build_debian_package.sh amd64 10
# armhf raspbian ./build_debian_package.sh armhf 10
#
# arg2 - COMPAT
#

# Package version
MAJOR_VERSION=`head -n4 VERSION.m4 | grep major_version | cut -c30- | tr -d "[]()"`
MINOR_VERSION=`head -n4 VERSION.m4 | grep minor_version | cut -c30- | tr -d "[]()"`
Expand Down

0 comments on commit 9b88cfb

Please sign in to comment.