diff --git a/README.md b/README.md index 99a197b..af59e4f 100644 --- a/README.md +++ b/README.md @@ -73,10 +73,16 @@ CL-USER> (clog:clog-install-dir) You can the load the demos with: ``` -CL-USER> (load "path to clog/demos/01-snake.lisp) +CL-USER> (load "path to clog/demos/01-snake.lisp") CL-USER> (clog-user:start-demo) ``` +To open a browser with the CLOG manual: + +``` +CL-USER> (clog:open-manual) +``` + Work your way through the tutorials. You will see how quick and easy it is to be a CLOGer. diff --git a/clog-docs.lisp b/clog-docs.lisp index ee31e39..96aae19 100644 --- a/clog-docs.lisp +++ b/clog-docs.lisp @@ -19,8 +19,6 @@ David Botton License BSD 3-Clause License -- Introduction - The Common Lisp Omnificent GUI, CLOG for short, uses web technology to produce graphical user interfaces for applications locally or remotely. CLOG can take the place, or work alongside, most cross-platform GUI @@ -28,10 +26,10 @@ frameworks and website frameworks. The CLOG package starts up the connectivity to the browser or other websocket client (often a browser embedded in a native template application.) -STATUS: CLOG is complete enough for most uses. See the README.md for -some enhacements bing worked on, CLOG is actually based on GNOGA, a +STATUS: CLOG is complete enough for most uses. See below for some +enhacements bing worked on, CLOG is actually based on GNOGA, a framework I wrote for Ada in 2013 and used in commercial production -code for the last 6 years, i.e. the techiniques CLOG uses are solid +code for the last 8 years, i.e. the techiniques CLOG uses are solid and proven. Some potential applications for CLOG: @@ -68,14 +66,31 @@ git clone https://github.com/rabbibotton/clog.git To load this package and work through tutorials (assuming you have Quicklisp configured): -1. cd to the CLOG dir (the dir should be one used by Quicklisp ex. ~/common-lisp/) -2. Start emacs/slime or your common lisp \"repl\" in _that_ directory. -3. In the REPL, run: +1. Start emacs then M-x slime +2. In the REPL, run: ``` CL-USER> (ql:quickload :clog) -CL-USER> (load \"~/common-lisp/clog/tutorial/01-tutorial.lisp\") -CL-USER> (clog-user:start-tutorial) +CL-USER> (clog-user:run-tutorial 1) +``` + +To see where the source files are: + +``` +CL-USER> (clog:clog-install-dir) +``` + +You can the load the demos with: + +``` +CL-USER> (load \"path to clog/demos/01-snake.lisp\") +CL-USER> (clog-user:start-demo) +``` + +To open a browser with the CLOG manual: + +``` +CL-USER> (clog:open-manual) ``` Work your way through the tutorials. You will see how quick and easy it is diff --git a/clog-helpers.lisp b/clog-helpers.lisp index 6a3a0b6..1fb3c80 100644 --- a/clog-helpers.lisp +++ b/clog-helpers.lisp @@ -25,6 +25,16 @@ "Return the directory CLOG was installed in." (asdf:system-source-directory :clog)) +;;;;;;;;;;;;;;;;; +;; open-manual ;; +;;;;;;;;;;;;;;;;; + +(defun open-manual () + "Launches a browser with CLOG manual." + (open-browser :url (format nil "~A" + (merge-pathnames "./doc/clog-manual.html" + (asdf:system-source-directory :clog))))) + ;;;;;;;;;;;;;;;;;; ;; run-tutorial ;; ;;;;;;;;;;;;;;;;;; diff --git a/clog.lisp b/clog.lisp index 95e1272..4c013c3 100644 --- a/clog.lisp +++ b/clog.lisp @@ -735,6 +735,7 @@ embedded in a native template application.)" (defsection @clog-helpers (:title "CLOG Helper Functions") "Tutorial and demo helpers" (clog-install-dir function) + (open-manual function) (run-tutorial function) "Functions for Compilation and Documentation" diff --git a/doc/clog-manual.html b/doc/clog-manual.html index f4e676d..dbf12f3 100644 --- a/doc/clog-manual.html +++ b/doc/clog-manual.html @@ -75,10 +75,6 @@ embedded in a native template application.)

License BSD 3-Clause License

- -

The Common Lisp Omnificent GUI, CLOG for short, uses web technology to produce graphical user interfaces for applications locally or remotely. CLOG can take the place, or work alongside, most cross-platform GUI @@ -86,10 +82,10 @@ frameworks and website frameworks. The CLOG package starts up the connectivity to the browser or other websocket client (often a browser embedded in a native template application.)

-

STATUS: CLOG is complete enough for most uses. See the README.md for -some enhacements bing worked on, CLOG is actually based on GNOGA, a +

STATUS: CLOG is complete enough for most uses. See below for some +enhacements bing worked on, CLOG is actually based on GNOGA, a framework I wrote for Ada in 2013 and used in commercial production -code for the last 6 years, i.e. the techiniques CLOG uses are solid +code for the last 8 years, i.e. the techiniques CLOG uses are solid and proven.

Some potential applications for CLOG:

@@ -127,14 +123,25 @@ git clone https://github.com/rabbibotton/clog.git have Quicklisp configured):

    -

  1. cd to the CLOG dir (the dir should be one used by Quicklisp ex. ~/common-lisp/)

    2. -

  2. Start emacs/slime or your common lisp "repl" in that directory.

    3. +

  3. Start emacs then M-x slime

  4. In the REPL, run:

CL-USER> (ql:quickload :clog)
-CL-USER> (load "~/common-lisp/clog/tutorial/01-tutorial.lisp")
-CL-USER> (clog-user:start-tutorial)
+CL-USER> (clog-user:run-tutorial 1) + +

To see where the source files are:

+ +
CL-USER> (clog:clog-install-dir)
+ +

You can the load the demos with:

+ +
CL-USER> (load "path to clog/demos/01-snake.lisp")
+CL-USER> (clog-user:start-demo)
+ +

To open a browser with the CLOG manual:

+ +
CL-USER> (clog:open-manual)

Work your way through the tutorials. You will see how quick and easy it is to be a CLOGer. The next section also covers the basic programming concepts @@ -4998,13 +5005,25 @@ on-storage event is fired for changes to :local storage keys.

+ +

+ +

Functions for Compilation and Documentation