mirror of
https://github.com/rabbibotton/clog.git
synced 2025-12-06 18:50:42 -08:00
81 lines
3.3 KiB
Common Lisp
81 lines
3.3 KiB
Common Lisp
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;;;; CLOG - The Common Lisp Omnificent GUI ;;;;
|
|
;;;; (c) 2020-2021 David Botton ;;;;
|
|
;;;; License BSD 3 Clause ;;;;
|
|
;;;; ;;;;
|
|
;;;; clog-docs.lisp ;;;;
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
(in-package :clog)
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;; Exports - clog documentation sections
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
(defsection @clog-getting-started (:title "CLOG Getting Started")
|
|
"
|
|
# CLOG - The Common Lisp Omnificent GUI
|
|
|
|
## David Botton <david@botton.com>
|
|
|
|
### License BSD 3-Clause License
|
|
|
|
The Common Lisp Omnificient GUI, CLOG for short, uses web technology to
|
|
produce graphical user interfaces for applications locally or remotely.
|
|
CLOG can take the place, or work along side, most cross platform GUI
|
|
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, there are a few loose
|
|
ends (multimedia, client side storage, integrations with databases),
|
|
but CLOG is actually based on a framework I wrote for Ada, GNOGA, in
|
|
2013 and used in commercial production code for the last 6 years,
|
|
i.e. the techiniques it uses are solid and proven.
|
|
|
|
Some of the things CLOG can be used for:
|
|
|
|
* Cross platform GUIs and Reports
|
|
* Secure websites and complex interactive web applications
|
|
* Write mobile software
|
|
* Write massive multiplayer online games
|
|
* Monitoring software for embedded systems
|
|
* A fun way to teaching programming and advanced multi-tasking
|
|
parallel programming techniques. (CLOG is a parallel GUI)
|
|
* And the list goes on
|
|
|
|
The key to CLOG is the relationship it forms with a Browser window
|
|
or Browser control compiled to native code. CLOG uses websockets
|
|
for communications and the browser to render a GUI that maintanes
|
|
an active soft realtime connection. For most CLOG applications all
|
|
programming logic, events and decisions are done on the server
|
|
which can be local or remote over the web.
|
|
|
|
CLOG is developed on an M1 MacBook with ECL, it is tested fairly
|
|
regulary with SCBL on Linux, Windows and Intel MacBook. It should
|
|
in theory work on any system QuickLisp and CLACK will load on to.
|
|
|
|
CLOG will be in QuickSlip in the next update, but a good idea,
|
|
since I am still adding code daily, is to cloan the github repo
|
|
in to your ~/common-lisp directory:
|
|
|
|
```
|
|
cd ~/common-lisp
|
|
git clone https://github.com/rabbibotton/clog.git
|
|
```
|
|
|
|
To load this package and work through tutorials (assuming you
|
|
have QuickSlip 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:
|
|
|
|
CL-USER> (ql:quickload :clog)
|
|
CL-USER> (load \"~/common-lisp/clog/tutorial/01-tutorial.lisp\")
|
|
CL-USER> (clog-user:start-tutorial)
|
|
|
|
Work your way through the tutorials. You will see how quick and easy it is
|
|
to be a CLOGer.
|
|
|
|
")
|