- README: added link to the GUI manual

- added a conceptual explanation of instantiation (with picture)



git-svn-id: http://svn.openmoko.org/trunk/eda/fped@5636 99fdad57-331a-0410-800a-d7fa5415bdb3

Makefile

@@ -76,7 +76,8 @@ endif
 
 # ----- Rules -----------------------------------------------------------------
 
-.PHONY:		all dep depend clean install uninstall upload-manual update
+.PHONY:		all dep depend clean install uninstall manual upload-manual
+.PHONY:		update
 
 .SUFFIXES:	.fig .xpm
 
@@ -109,10 +110,14 @@ gui_tool.o gui.o: $(XPMS:%=icons/%)
 
 # ----- Upload the GUI manual -------------------------------------------------
 
-upload-manual:	$(XPMS:%=icons/%)
-		scp gui.html README $(UPLOAD)/
+manual:		$(XPMS:%=icons/%)
 		for n in $(XPMS:%.xpm=%); do \
 		    convert icons/$$n.xpm manual/$$n.png || exit 1; done
+		fig2dev -L png -S 4 manual/concept-inst.fig \
+		    >manual/concept-inst.png
+
+upload-manual:	manual
+		scp gui.html README $(UPLOAD)/
 		scp $(XPMS:%.xpm=manual/%.png) $(PNGS:%=manual/%) \
 		  $(UPLOAD)/manual/
 

README

@@ -445,6 +445,10 @@ Parentheses can be used to change precedence.
 GUI
 ---
 
+Part of the GUI is described in
+http://people.openmoko.org/werner/fped/gui.html
+
+
 Keyboard shortcuts
 - - - - - - - - -
 

gui.html

@@ -17,8 +17,11 @@ Footprints tend to be highly repetitive, with many pads placed in a
 simple geometrical pattern. With fped, the user specifies the elements
 to repeat and the way they are repeated. Fped then generates the
 repetitions automatically.
+
+<H2>Hands-on example</H2>
 <P>
-Here is a simple example:
+Here is a simple example that illustrated the basic steps of constructing
+things with fled:
 <UL>
   <LI> Start fped without a command-line argument.
   <LI> Right-click on the yellow field that says "(root)" and select
@@ -64,6 +67,19 @@ The innermost vector and circle are highlighted. You can highlight other
 instances of the same objects by clicking on the numbers (1 2 3 4 5) shown
 next to the loop.
 
+<H2>Conceptual view</H2>
+The following picture illustrates the concept: the model is defined in
+terms of objects, in this case a vector from the origin to the circle's
+center, a vector for the radius, and the circle itself.
+<P>
+<IMG src="manual/concept-inst.png">
+<P>
+The vector to the center uses a variable that gets iterated through the
+values 0, 1, and 2. For each iteration, an instance is generated.
+<P>
+Only the instances of silk screen objects and pads are exported to KiCad.
+Elements used for construction, such as vectors, only appear in fped.
+
 
 <H1>Frames</H1>
 

manual/concept-inst.fig

@@ -0,0 +1,35 @@
+#FIG 3.2  Produced by xfig version 3.2.5a
+Landscape
+Center
+Metric
+A4      
+100.00
+Single
+-2
+1200 2
+0 32 #c0c000
+1 1 0 5 3 7 40 -1 -1 0.000 1 0.0000 3600 4500 450 225 3600 4500 4050 4500
+1 1 0 5 3 7 40 -1 -1 0.000 1 0.0000 6300 4501 450 225 6300 4501 6750 4501
+1 1 0 5 3 7 40 -1 -1 0.000 1 0.0000 4950 4500 450 225 4950 4500 5400 4500
+1 1 0 1 12 12 50 -1 20 0.000 1 0.0000 3150 6075 90 45 3150 6075 3240 6075
+1 1 0 3 12 7 50 -1 -1 0.000 1 0.0000 3150 6075 180 90 3150 6075 3330 6075
+1 1 0 5 16 7 40 -1 -1 0.000 1 0.0000 4500 6075 450 225 4500 6075 4950 6075
+2 1 0 2 0 7 45 -1 -1 0.000 0 0 -1 0 0 3
+	 2925 3600 1800 5175 6975 5175
+2 1 1 2 0 7 35 -1 -1 6.000 0 0 -1 0 0 2
+	 3150 6075 3600 4500
+2 1 0 2 0 7 35 -1 -1 6.000 0 0 -1 0 0 2
+	 3825 6165 4275 6750
+2 1 0 3 32 7 45 -1 -1 0.000 0 0 -1 1 0 2
+	0 0 3.00 135.00 120.00
+	 4500 6075 4635 5850
+2 1 0 3 32 7 45 -1 -1 0.000 0 0 -1 1 0 2
+	0 0 3.00 135.00 135.00
+	 3150 6075 4500 6075
+4 1 0 35 -1 18 12 0.0000 4 165 390 3600 4140 n=0\001
+4 1 0 35 -1 18 12 0.0000 4 165 390 4950 4140 n=1\001
+4 1 0 35 -1 18 12 0.0000 4 165 390 6300 4140 n=2\001
+4 1 0 35 -1 18 12 0.0000 4 210 660 3150 6435 Origin\001
+4 0 0 35 -1 18 12 0.0000 4 180 1305 4050 6975 n*4mm, 0mm\001
+4 0 0 35 -1 18 12 0.0000 4 210 1650 1800 7200 Objects (model)\001
+4 0 0 35 -1 18 12 0.0000 4 165 1005 4050 3600 Instances\001