X-Authentication-Warning:	delorie.com: mail set sender to geda-user-bounces using -f
X-Recipient:	geda-user AT delorie DOT com
Date:	Sun, 16 Aug 2015 10:39:01 +0200 (CEST)
X-X-Sender:	igor2 AT igor2priv
To:	geda-user AT delorie DOT com
X-Debug:	to=geda-user AT delorie DOT com from="gedau AT igor2 DOT repo DOT hu"
From:	gedau AT igor2 DOT repo DOT hu
Subject:	[geda-user] [pcb-rnd] scripting docs
Message-ID:	<alpine.DEB.2.00.1508161022460.6924@igor2priv>
User-Agent:	Alpine 2.00 (DEB 1167 2008-08-23)
MIME-Version:	1.0
Reply-To:	geda-user AT delorie DOT com

Hi all,

I've been working on the documentation for pcb-rnd scripting lately. 
Proof reading and comments would be appreciated. The documents are 
work-in-progress.

I have a Rosetta stone of examples demonstrating how to write simple 
scripts: http://repo.hu/projects/pcb-rnd/gpmi/rosetta/index.html
It doesn't explain how the system works, but shows easy-to-understand 
practical examples. Useful for those who like learn by doing and look up 
the "theoretical" background only after seeing things in practice.

Another document, the scripting intro focuses on explaining how things are 
built up: http://repo.hu/projects/pcb-rnd/gpmi/scripting_intro.html
This one is useful for those who first want to understand the design 
and then look at how to do things in practice.

As a next step I plan to reorganize the package documentation and split 
them all into a high level "what's the concept" doc and a low level 
reference manual.

I also plan to improve the links between the docs and write more rosetta 
examples. I plan to have a few more all-language examples on the most 
basic things. The more complex examples would be written in awk, lua and 
maybe ruby.

Regards,

Igor2

P.S. I'm still looking for alpha testers

- Raw text -