Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

nyx-lib

Nyx is the webOS portability layer used to isolate the remainder of webOS from dependencies on the hardware and core OS upon which it is running. It is implemented as a shared library that exposes a uniform client API and that expects to call into a series of platform-dependent modules that implement the API for a particular device.

This is the repository for nyx-lib, the shared library.

How to Build on Linux

Dependencies

Below are the tools and library (and their minimum versions) required to build nyx-lib:

  • cmake 2.6
  • gcc 4.3
  • glib-2.0 2.16
  • make (any version)
  • pkg-config 0.22

Building

Once you have downloaded the source, execute the following to build it:

$ mkdir BUILD
$ cd BUILD
$ cmake ..
$ make
$ sudo make install

The header files will be installed under

/usr/local/include/nyx

and the libraries under

/usr/local/lib

You can install it elsewhere by supplying a value for CMAKE_INSTALL_PREFIX when invoking cmake. For example:

$ cmake -D CMAKE_INSTALL_PREFIX:STRING=$HOME/projects/openwebos ..
$ make
$ make install

will install the header files under

$HOME/projects/openwebos/include/nyx

and the libraries under

$HOME/projects/openwebos/lib

directory.

Generating documentation

The tool required to generate the documentation is:

  • doxygen 1.6.3

Once you have downloaded the source, execute the following to generate the documentation:

$ cd doc
$ ./create_docs.sh

To view the generated HTML documentation, point your browser to

doc/html/index.html

Copyright and License Information

All content, including all source code files and documentation files in this repository are:

Copyright (c) 2010-2012 Hewlett-Packard Development Company, L.P.

All content, including all source code files and documentation files in this repository are: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this content except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.