aboutsummaryrefslogtreecommitdiff
path: root/examples.api/README
diff options
context:
space:
mode:
authorSteve Bennett <steveb@workware.net.au>2010-10-14 23:14:06 +1000
committerSteve Bennett <steveb@workware.net.au>2010-10-15 11:02:58 +1000
commit68c4bc3d300d0b1e3d2edd2c5411e92cb103acf1 (patch)
treed02655b450a295157e6d13c85ec97f878cb2ce00 /examples.api/README
parent0aefb9c552e6752dc8f1355b56ad5f81c7522ff2 (diff)
downloadjimtcl-68c4bc3d300d0b1e3d2edd2c5411e92cb103acf1.zip
jimtcl-68c4bc3d300d0b1e3d2edd2c5411e92cb103acf1.tar.gz
jimtcl-68c4bc3d300d0b1e3d2edd2c5411e92cb103acf1.tar.bz2
Re-add some files lost from v0.51
In particular the C examples (now in examples.api/) Signed-off-by: Steve Bennett <steveb@workware.net.au>
Diffstat (limited to 'examples.api/README')
-rw-r--r--examples.api/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/examples.api/README b/examples.api/README
new file mode 100644
index 0000000..d3fc8be
--- /dev/null
+++ b/examples.api/README
@@ -0,0 +1,36 @@
+Jim examples
+============
+BSD 2-clause license, (c) 2010 Wojciech A. Koszek <wkoszek@FreeBSD.org>
+
+
+This directory contains examples of Jim interpreter API. In order to start
+working with Jim API one may just want to copy existing example .c file
+into new file, modify Makefile and start working on a new program.
+
+Existing examples
+=================
+
+jim_command
+ Simple command implementation in Jim's API. Command is then executed
+ in a script encoded within a program.
+
+jim_hello
+ Standard "Hello world!" program.
+
+jim_inline
+ Similar "Hello world!" program, but the result comes from a Tcl
+ script interpreted in Jim. Result is printed back on a terminal.
+
+jim_list
+ Will teach you how to create a list in Jim's API. Once created,
+ will show how to name and export it, so that variable is visible in
+ the script's source code. Once done, interpretation of separate
+ print.tcl file is presented. As a result, the script can print a
+ list members created from within ANSI C program.
+
+jim_obj
+ Basic object creation in Jim.
+
+jim_return
+ Similar to jim_command example, but implemented command actually
+ returns a value.