Skip to content

Commit

Permalink
Overview comment.
Browse files Browse the repository at this point in the history
  • Loading branch information
psychogenic committed Jun 12, 2019
1 parent ad2d316 commit a84cc4d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/SerialUI.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,24 @@
* Copyright (C) 2014-2019 Pat Deegan, https://psychogenic.com
* More information on licensing and usage at
* https://devicedruid.com/
*
* SerialUI provides an embedded/host-side user interface, comprised of menus
* consisting of
* - commands (orders to take action);
* - inputs (user-supplied data, as text or numeric values);
* - data views (various views of evolving state); and
* - sub-menus containing more of the above;
*
* What the host does with the data, or when commands are received
* from the user, is up to the programmer implementing the body of the
* various callbacks that are triggered in response.
*
* SerialUI is designed to provide both "raw" (low-level) access to the
* functionality, through e.g. a USB serial connection, and to allow for
* programatic access through the device druid client application.
*
* See https://devicedruid.com/ for more info.
*
*/

#ifndef SERIALUIV3_SRC_SERIALUI_H_
Expand Down

0 comments on commit a84cc4d

Please sign in to comment.