Improved comments with installation instructions

lf-lang · Feb 27, 2024 · e69ab5f · e69ab5f
1 parent eafa407
commit e69ab5f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/examples/C/src/browser-ui/Uptime.lf b/examples/C/src/browser-ui/Uptime.lf
@@ -5,6 +5,15 @@
  * `WebSocketServer` reactor. The resulting web page simply reports the total time that this program
  * has been running. That time is updated on the web page once per second.
  *
+ * This uses the <a href="https://libwebsockets.org">libwebsockets</a> (see <a
+ * href="https://libwebsockets.org/lws-api-doc-main/html/index.html">API documentation</a> and <a
+ * href="https://libwebsockets.org/lws-api-doc-main/html/md_READMEs_README_build.html">installation
+ * instructions</a>). To install on MacOS, we recommending using brew:
+ * <pre> brew install libwebsockets
+ * </pre> This puts the compiled libraries in {@code /usr/local/lib}, and these libraries can be
+ * linked to using the {@code -lwebsockets} compile option or the {@code WebSocketCmake.txt} Cmake
+ * include file.
+ *
  * @author Edward A. Lee
  */
 target C {

diff --git a/examples/C/src/browser-ui/WebSocket.lf b/examples/C/src/browser-ui/WebSocket.lf
@@ -12,6 +12,15 @@
  * will receive odd numbered counts. This is because the count state variable is shared across all
  * clients.
  *
+ * This uses the <a href="https://libwebsockets.org">libwebsockets</a> (see <a
+ * href="https://libwebsockets.org/lws-api-doc-main/html/index.html">API documentation</a> and <a
+ * href="https://libwebsockets.org/lws-api-doc-main/html/md_READMEs_README_build.html">installation
+ * instructions</a>). To install on MacOS, we recommending using brew:
+ * <pre> brew install libwebsockets
+ * </pre> This puts the compiled libraries in {@code /usr/local/lib}, and these libraries can be
+ * linked to using the {@code -lwebsockets} compile option or the {@code WebSocketCmake.txt} Cmake
+ * include file.
+ *
  * @author Edward A. Lee
  */
 target C {