diff --git a/MANUAL.md b/MANUAL.md new file mode 100644 index 0000000..90e5638 --- /dev/null +++ b/MANUAL.md @@ -0,0 +1,22 @@ + +[CLOG - Tutorials and Learning Material](LEARN.md) +[CLOG - Reference Manual](https://rabbibotton.github.io/clog/clog-manual.html) + + +CLOG Builder Video Manual Index +=============================== +[CLOG - Video Manual Play List](https://www.youtube.com/playlist?list=PLSUeblYuDUiOlX28-v8T__aM-2XO32vR_) + +[Video notes](doc/vm-index.md) + +1. Intro - https://youtu.be/cuXs5gyUWxE + +* Installing and new Projects + +2. Install QuickLisp - https://youtu.be/CipzbZkPjBM +3. Install OCICL - https://youtu.be/CIDo8vaOy1c + +* Projects + +4. First Project - https://youtu.be/IZqHuYw9jRI +5. Using Projects and Plugins \ No newline at end of file diff --git a/doc/v1.md b/doc/v1.md new file mode 100644 index 0000000..61981ec --- /dev/null +++ b/doc/v1.md @@ -0,0 +1,21 @@ + +The CLOG Builder Video Manual Series - Video 1 + +1. Goal is to document all the features +2. Small videos so can replace if feature updated +3. Hopefully someone will consider joining the team and + do an html based manual +4. Encourage people to try and use CLOG and the CLOG Builder +5. Generate excitement to for “Common Lisp - The Language of Innovation” +6. Stability and multiple implementations more important than "New" +7. Innovation is not new, it is improving on what already is succesful + +Why CLOG? + +1. The only cross platform and device graphic platform is HTML +2. CLOG apps can run as desktop apps, mobile apps, websites, + webapps and iot apps +3. Is stable, proven and fun for programmers. Use existing web designers and + tools. +4. Speed from idea to production ready, nothing beats Common Lisp and nothing + beats HTML for quick designs, CLOG makes it real now. \ No newline at end of file diff --git a/doc/v2.md b/doc/v2.md new file mode 100644 index 0000000..76309f3 --- /dev/null +++ b/doc/v2.md @@ -0,0 +1,31 @@ + +The CLOG Builder Video Manual Series Video 2 + +Getting Started - Installs + +CLOG works with QuickLisp and with OCICL distribution for builds (next video). + +To install Common Lisp with QuikLisp: + +Install Common-Lisp for MacOS +Install Common-Lisp for Linux +Install Common-Lisp For Android (Termux) +Install Common-Lisp for Win64 + +Links on the git page - https://github.com/rabbibotton/clog + +Check out the Learn page there - https://github.com/rabbibotton/clog/blob/main/LEARN.md + +For more advanced users: + +Install and Using OCICL on all platforms +For those new to Common Lisp or just want to quickly try CLOG use ther simple EZ +standalone versions: + +https://github.com/rabbibotton/clog-win64-ez/releases +https://github.com/rabbibotton/clog-linux-ez +https://github.com/rabbibotton/clog-linux-arm-ez +https://github.com/rabbibotton/clog-mac-ez +Unzip, double click setup.bat or ./setup Run builder.exe or ./builder +Update (almost daily :) use update.bat or ./update + diff --git a/doc/v3.md b/doc/v3.md new file mode 100644 index 0000000..27697da --- /dev/null +++ b/doc/v3.md @@ -0,0 +1,30 @@ + +The CLOG Builder Video Manual Series Video 3 + +Getting Started with OCICL + +Fantastic for production builds +Control over versions - can pin down versions +Secure downloads and packages + +CLOG Builder has been set up to play nice without QuickLisp + +OCICL is based around a single directory, your project, in its own world + (that may have other sub projects) + +Once installed you go to a new directory (or existing CLOG project) + +First time setup: + +ocicl setup > init +ocicl install clog + +Enter your sbcl world: + +sbcl --userinit init + +* (asdf:load-system :clog/tools) +* (clog-tools:clog-builder) + +Get the latest clog and more: +ocicl latest diff --git a/doc/v4.md b/doc/v4.md new file mode 100644 index 0000000..d80c849 --- /dev/null +++ b/doc/v4.md @@ -0,0 +1,13 @@ + +The CLOG Builder Video Manual Series Video 4 + +Getting Started with first project + +1. Start up the Builder + a. QuickLisp (ql:quickload :clog/tools)(clog-tools:clog-builder) + b. OCICL (asdf:load-system :clog/tools)(clog-tools:clog-builder) +2. With OCICL project already there +3. With QuickLisp Project -> New Project from Template +4. The Project Tree +5. ASD Edit + diff --git a/doc/v5.md b/doc/v5.md new file mode 100644 index 0000000..f070328 --- /dev/null +++ b/doc/v5.md @@ -0,0 +1,50 @@ + +The CLOG Builder Video Manual Series Video 5 + +Using your Project and using Plugins + +Start up the Builder start the clog builder in your lisp with: +``` + a. QuickLisp (anywhere): (ql:quickload :clog/tools)(clog-tools:clog-builder) + b. In an OCICL Project Dir: (asdf:load-system :clog/tools)(clog-tools:clog-builder) +``` + +Templates create batch files run-ql(.bat) and run-ocicl(.bat) that can be +modified for your project needs for runing the builder simply with sbcl +(if using ecl, ccl, LispWorks, or Allegro you will need to modify it). + +setup-ocicl(.bat) is also created to either convert project later to OCICL or +first time run. + +Adding Plugins to your project + +1. Install the plugin in + a. location ASDF can find the plugin (like `~/common-lisp`) + b. if using QuickLisp for example `(ql:quickload :clog-ace/tools)`` + c. if using OCICLfor example `ocicl install clog-ace` + +2. Open the ASD Project Window (in project tree asd edit). + +3. In the bottom right of the window choose plugin and type the name of your + plugin. For example "clog-ace" + +4. Your plugin will be loaded and any custom control added to the GUI builder + (as login as your project is loaded with ":myproj/tools" your plugins + should be installed and available each time you load your project.) + + +NOTE: + +If you wish to make any plugins always available to use in the Builder see +Options -> Edit preferences.lisp + +If you use the plugin though you must add it to your .asd file + + +NOTE (ADVANCED): +If you add plugins or dependencies at non-standard locations +you can directly add the project's location using: +``` +(pushnew #P"/path/to/a/project" asdf:*central-registry* :test #'equalp) +``` +in a --eval to sbcl or ecl, etc. before loading your project or the builder. diff --git a/doc/vm-index.md b/doc/vm-index.md new file mode 100644 index 0000000..fb0abc0 --- /dev/null +++ b/doc/vm-index.md @@ -0,0 +1,28 @@ + +The CLOG Builder Video Manual Series - Index + +1. Introduction to CLOG and the CLOG Builder +2. Installing CLOG and CLOG Builder - QuickLisp +3. Installing CLOG and CLOG Builder - OCICL +4. Getting Started with your First Project +5. Using your Project and using CLOG Plugins +6. Addind new Lisp files or GUI panels to your project +7. Runtime vs Design time files and dependencies +8. Custom ASD files, loading projects from the REPL, loading lisp files +9. One Lisp image - many editors, tools and REPLs +10. Local and Remote use - via swank or http +11. The CLOG Builder is an extension of your current tools +12. CLOG Builder Interface and The Soure editor +13. The Panel editor +14. The project tree +15. Tbe directory tree +16. The system source browser and the regex file search tool +17. Loaded ASDF system browser +18. The CLOG Builder REPL - REPL Consoles +19. The CLOG Builder Console +20. The OS pseudo shell +21. Thread viewer +22. CLOG Probe Panel - *clog-debug-instance* +23. CLOG Object Scope +24. Image to HTML Data +25. Builder Preferences