update docs

0.2/README.md

@@ -0,0 +1,7 @@
+# PalmSDK 0.2 (Redux)
+
+This folder contains the SDK itself: command line tools and sample code.
+
+It requires novacomd and Java. Optional but recommended is novacom.
+
+If you're unsure how to proceed, run install.sh in the parent folder.

MODERNIZING.md

@@ -12,15 +12,6 @@ Cross-Platform Compatibility Confirmed ✓
   2. If found, uses it directly
   3. If not found, shows error
 
-  POSIX Compliance
-
-  All commands and syntax used are POSIX-compliant:
-  - command -v java (standard way to check for commands)
-  - uname -s (platform detection)
-  - sed with Basic Regular Expressions (BRE)
-  - grep -i (case-insensitive search)
-  - [ -lt ] (numeric comparison)
-
   Tested Version Formats
 
   Works with all Java version formats:

README.md

@@ -1,18 +1,27 @@
 # PalmSDK 0.2 Overview
 
-This is a modernization of the 2011-era webOS SDK and driver for the Palm/HP mobile operating system. It works with devices like the Palm Pre or the HP TouchPad.
+This is a modernization of the 2011-era webOS SDK and driver for the Palm/HP mobile operating system. It works with devices like the Palm Pre or the HP TouchPad on modern desktop platforms.
 
 The SDK consists of three parts, two of which were initially distributed separately. These parts have been combined and modernized for convenience and manageability:
 
-- novacomd: the driver that communicated with the webOS device
-- novacom: a utility that interacts with the driver for basic device interaction
+- novacomd: the driver that communicates with the webOS device
+- novacom: a utility that interacts with the driver for basic device commands
 - sdk tools and content: command line tools and sample code for building, installing and interacting with webOS apps and services
 
-Most deployments will use all three parts, but you can also pick and choose based on your needs.
+The easiest, and most common deployment will use all three parts, but you can also pick and choose based on your needs.
+
+## Pre-requisites
+
+- This SDK is for modern *nix-based Operating Systems: macOS (Intel or Apple Silicon) or 64-bit Linux. If you have another platform (Windows, OSX or 32-bit Linux), the legacy SDK will likely work for you.
+- You will need some version of Java. This version of the toolchain is very tolerant of different versions of Java, but make sure you have at least Java 8 working!
+- You will need build tools for your platform. On Linux these are installed with your package manager and called `build-essential` or `Development Tools`. On macOS this means XCode Command Line tools and [Homebrew](https://brew.sh/).
+- You will need libusb. On Linux this is `libusb-dev` or `libusb-devel`. On macOS, this is `libusb-compat` from Homebrew.
+
+The installers will *try* to help you with these pre-reqs, but its always best if you get them working first!
 
 ## Installation (All Parts)
 
-- Run ./build-and-install from the root of this folder
+- Run ./install.sh from the root of this folder
 
 ## Installation (Individual Parts)
 
@@ -30,11 +39,12 @@ This is optional, but useful for some SDK operations and device troubleshooting
 
 - Ensure you have novacomd built and installed -- novacom will use the same path as novacomd.
 - Run `./build.sh` from the `novacom` folder. If the build succeeds it will offer to install.
-- If you need to troubleshoot, you can separately run `./install.sh`
+- If you need to troubleshoot, you can separately run `./install-<platform>.sh
 - See BUILD_SUMMARY.md in the novacom folder for troubleshooting.
 
 ## SDK
 
 If you want to build webOS applications, you'll need the SDK. You don't strictly have to install it, but it can be helpful to have it in your path. Typically you'll install this in the same place as novacom (if you built it).
 
-- **Run `./install.sh` from the `Current` folder TBD**
+- Ensure you have installed novacomd and novacom
+- Run `./install-<platform>.sh from the `0.2` folder

novacom/README.md

@@ -1,19 +1,22 @@
-novacom
-=======
+# novacom
 
-Summary
--------
-Utility to communicate with an embedded device over USB
+Utility to communicate with an embedded device over USB.
 
-Description
------------
-_novacom_ and _novacomd_ provide a generic toolset to allow communication between a host
-and an embedded device using sockets over USB.
+## Description
+_novacom_ and _novacomd_ provide a generic toolset to allow communication between a host and an embedded device using sockets over USB.
 
-How to Build on Linux
-=====================
+## Install
 
-## Dependencies
+- Install novacomd
+- Run `./install-<yourplatform>.sh` in this directory
+
+## Uninstall
+
+- Run `/.uninstall-<yourplatform>.sh` in this directory
+
+## Build
+
+### Dependencies
 
 Below are the tools and library (and their minimum versions) required to
 build _novacom_:
@@ -24,24 +27,29 @@ build _novacom_:
 - openwebos/cmake-modules-webos 1.0.0 RC4
 - pkg-config 0.26
 
-## Building
+### Make
 
-Once you have downloaded the source, enter the following to build it (after
-changing into the directory under which it was downloaded):
+The easy path is to run `build.sh` in this folder
 
+If you prefer to build manually:
+
+```
 	$ mkdir BUILD
 	$ cd BUILD
 	$ cmake ..
 	$ make
 	$ sudo make install
+```
 
 The directory under which the files are installed defaults to `/usr/local/webos`.
 You can install them elsewhere by supplying a value for `WEBOS_INSTALL_ROOT`
 when invoking `cmake`. For example:
 
+```
 	$ cmake -D WEBOS_INSTALL_ROOT:PATH=$HOME/projects/openwebos ..
 	$ make
 	$ make install
+```
 
 will install the files in subdirectories of `$HOME/projects/openwebos`.
 
@@ -53,12 +61,16 @@ environment variable.
 If not specified, `WEBOS_INSTALL_ROOT` defaults to `/usr/local/webos`.
 
 To configure for a debug build, enter:
-
+```
 	$ cmake -D CMAKE_BUILD_TYPE:STRING=Debug ..
-
+```
 To see a list of the make targets that `cmake` has generated, enter:
-
+```
 	$ make help
+```
+## Running
+
+novacom requires novacomd
 
 ## Uninstalling
 
@@ -68,7 +80,7 @@ From the directory where you originally ran `make install`, enter:
 
 You will need to use `sudo` if you did not specify `WEBOS_INSTALL_ROOT`.
 
-# Copyright and License Information
+## Copyright and License Information
 
 Unless otherwise specified, all content, including all source code files and
 documentation files in this repository are:

novacomd/BUILD_SUMMARY.md

@@ -105,13 +105,13 @@ For creating an installer, the following dependencies are required:
 - [x] Builds without warnings
 - [x] Binary runs and shows version
 - [x] Dependencies correctly linked
-- [ ] Builds on macOS Apple Silicon
-- [ ] Builds on Linux x86_64
+- [x] Builds on macOS Apple Silicon
+- [x] Builds on Linux x86_64
 - [ ] Builds on Linux ARM64
-- [ ] Connects to webOS device via USB
-- [ ] palm-install works with new binary
-- [ ] palm-log works with new binary
-- [ ] palm-launch works with new binary
+- [x] Connects to webOS device via USB
+- [x] palm-install works with new binary
+- [x] palm-log works with new binary
+- [x] palm-launch works with new binary
 
 ## License
 

novacomd/README.md

@@ -140,7 +140,7 @@ See [DEPENDENCIES.md](DEPENDENCIES.md) for detailed dependency information.
 
 # macOS Service registration
 
-Steps to set up an agent or daemon:
+This is performed automatically as part of the install. If you wish to do this manually, follow these steps to set up an agent or daemon:
 
     Create a program that you want to run in the background
     Create a .plist file describing the job to run (See below for how to author one)