From 5ba99d4e989f62de33a16e5996c2dff5a4e2f753 Mon Sep 17 00:00:00 2001 From: vindarel Date: Thu, 16 Mar 2023 18:31:37 +0100 Subject: [PATCH] (minor) docs: scripting intro, footer --- docs/index.html | 4 +++- docs/scripting.md | 16 ++++++++++++++-- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/index.html b/docs/index.html index 54967f6..12aeb77 100644 --- a/docs/index.html +++ b/docs/index.html @@ -48,7 +48,8 @@ var footer = [ '
', '' ].join(''); @@ -65,5 +66,6 @@ + diff --git a/docs/scripting.md b/docs/scripting.md index 9aa5615..a880d4c 100644 --- a/docs/scripting.md +++ b/docs/scripting.md @@ -1,6 +1,15 @@ # Scripting -> Note: this is brand new! Expect limitations and changes. +CIEL provides a fast-starting scripting solution for Common Lisp. + +It is based on a standalone binary (created with the fast SBCL +implementation) and it ships useful built-in utilities, for real-world +needs: HTTP, JSON, CSV handling, plotting, and more. You just have to +get the binary and run your script. Use a shebang line if you wish. + +It's a fast and easy solution to write Lisp code for your day-to-day tasks. + +> Note: this is brand new! Expect limitations and changes. Get the `ciel` binary and call it with your .lisp script: @@ -8,7 +17,7 @@ Get the `ciel` binary and call it with your .lisp script: $ ciel script.lisp ``` -(or `./script.lisp` with a shebang line, see below) +(or just `./script.lisp` with a shebang line, see below) Call built-in scripts: @@ -21,6 +30,9 @@ $ ciel -s simpleHTTPserver 9000 An example script: ```lisp +#!/usr/bin/env ciel +;; optional shebang line, only for the short ./script call) + ;; Start your script with this to access all CIEL goodies: (in-package :ciel-user)