Skip to content
Browse files

Add corrections to README.md and comments in CMakeLists.txt

Open-webOS-DCO-1.0-Signed-off-by: Sapna Todwal <sapna.todwal@palm.com>

Change-Id: Iec1ffdb3e43aeaa16001503f22e1e48c25283574
  • Loading branch information...
1 parent 1bc8d00 commit aed79f04c511e751e8c8d224f1a69d87a131e18b Sapna Todwal committed Oct 5, 2012
Showing with 25 additions and 9 deletions.
  1. +1 −1 .gitignore
  2. +4 −0 CMakeLists.txt
  3. +20 −8 README.md
View
2 .gitignore
@@ -1,6 +1,6 @@
# @@@LICENSE
#
-# Copyright (c) 2012 Hewlett-Packard Development Company, L.P.
+# Copyright (c) 2010-2012 Hewlett-Packard Development Company, L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
View
4 CMakeLists.txt
@@ -16,6 +16,10 @@
#
# LICENSE@@@
+# The values for following variables can be set from command line
+# NYX_MODULE_DIR - Location of installed nyx modules
+# NYX_MODULE_MOCK_DIR - Location of mock modules (if any)
+
cmake_minimum_required(VERSION 2.8.7)
project(nyx)
View
28 README.md
@@ -2,7 +2,7 @@ nyx-lib
=======
Summary
-------
-Open webOS Platform Portability Layer
+Open webOS Platform Portability Layer
Description
-----------
@@ -26,7 +26,7 @@ Below are the tools and libraries (and their minimum versions) required to build
* gcc 4.6.3
* glib-2.0 2.32.1
* make (any version)
-* openwebos/cmake-modules-webos 1.0.0 RC3
+* openwebos/cmake-modules-webos 1.0.0 RC4
* pkg-config 0.26
## Building
@@ -65,6 +65,11 @@ To see a list of the make targets that `cmake` has generated, enter:
$ make help
+You may also specify `NYX_MODULE_DIR` and `NYX_MODULE_MOCK_DIR` from
+command line to override the default settings. The default settings
+are extracted from variables `nyx_module_dir` and `nyx_module_mock_dir`
+in nyx.pc.
+
## Uninstalling
From the directory where you originally ran `make install`, enter:
@@ -73,10 +78,11 @@ From the directory where you originally ran `make install`, enter:
You will need to use `sudo` if you did not specify `WEBOS_INSTALL_ROOT`.
-## Generating documentation
-
## Generating Documentation
+Nyx generates two sets of documentation, reflecting that fact that the APIs
+it presents to application and module writers are different.
+
The tools required to generate the documentation are:
- doxygen 1.7.6.1
@@ -86,15 +92,21 @@ Once you have run `cmake`, enter the following to generate the documentation:
$ make docs
-To view the generated HTML documentation, point your browser to
-`Documentation/<project-name>/html/index.html`
+To view the generated HTML documentation, point your browser to either of the
+following
+
+ Documentation/nyx/module_api/html/index.html
+ Documentation/nyx/client_api/html/index.html
+
+in your build directory.
To install the generated documentation, enter:
$ [sudo] make install-docs
-The documentation will be installed to `usr/share/doc/<project-name>/html` under
-the tree defined by the value of `WEBOS_INSTALL_ROOT` (or its default).
+The documentation will be installed to `usr/share/doc/nyx/module_api/html`and
+`usr/share/doc/nyx/client_api/html` under the tree defined by the value of
+`WEBOS_INSTALL_ROOT` (or its default).
You will need to use `sudo` if you did not specify `WEBOS_INSTALL_ROOT`.

0 comments on commit aed79f0

Please sign in to comment.
Something went wrong with that request. Please try again.