gEDA

GNU Electronic Design Automation
------------------------------------------------------------------------------


README for misc utilities 
(This software is ALPHA)


IMPORTANT
	Please read the file NEWS for details on specifics for this release


- Installation

	See the toplevel INSTALL for more instructions on general install
	instructions

- Utilities

   gmk_sym		
   Written by: Jerry O'Keefe, jerryok@pacbell.net 

	This is a simple utility to convert comma separated
	descriptions into rectangular gschem symbols.  It should
	be useful for easily creating memory, processors or
	connector style parts. All pin positions are in normal pin
	spacing (300).	Pin styles supported are line, dot-line,
	and clock line. Pins can be placed on all sides of the
	symbol's box. For example to place a dot-line style pin of
	name INPUT at the normal pin 1 position of a IC would be:

		INPUT,1,dot,L,1

	The size of the symbol's box is also in pin spacings. So
	a symbol with 6 inputs and 6 outputs would typically
	require a size of: 3 for width and 7 for height.

	See the included 7474.txt and 8031.txt as example files.

	This utility is not strong on error checking and slotting
	is not supported.
		
	gmk_sym typical use:

		./gmk_sym 7474.txt >7474-3.sym

	gmk_sym is installed when make install is run.



   smash_megafile		
   Written by: Mike Jarabek, mjarabek@playground.net

	smash_megafile is a C program that will take a viewlogic
	megafile and extract the contents into a directory of the same
	name, with one file representing each element in the library.
	This program should compile without any problems for anyone.
	This program cannot create megafiles, it can just extract all
	the contents. (Useful for say, extracting all the symbols from
	a library...)  Be aware that megafiles from PC versions of
	ViewDraw use PC end of line terminations, it may be necessary
	to use a program like dos2unix to convert the resulting text
	files... before doing useful things with them.

	smash_megafile typical use:

		 ./smash_megafile megafile

	where megafile is the name of a viewlogic megafile whithout
	any extensions.  The file megafile.lib and megafile.tbl must
	exist in the same directory

	smash_megafile is installed when make install is run.


   convert_sym.awk		
   convert_sym.c
   Written by: Mike Jarabek, mjarabek@playground.net

	convert_sym.awk is an AWK script which takes ViewLogic Viewdraw
	schematic or symbol and outputs a gschem compatible file. This 
	awk script is now OBSOLETE and will be replaced completely by
	the C version.  It's just included in the dist as a reference for
	other converter authors.

	convert_sym.c does the same thing as the AWK script but is
	written in C and has some bugs fixed.  

	This utility should be considered a work in progress.
	Be warned, the program has quite a few limitations:

		1) gEDA does not have a 'bus' type net, so for the
		   moment, busses are output as simple nets.

		2) I don't think that I am adding net names correctly
		   to the output schematic, gnetlist does not seem to
		   pick up the right names.

		3) Viewlogic text uses a text origin system that has
		   9 anchor points for the text.  Text in geda only has
		   one anchor point, so the text anchoring position is
		   approximated by shifting text around. This may result
		   in wierd looking text positions.

		4) Some text spacing may be lost due to the way that I
		   extract the text from the viewlogic records

		5) Rotated and mirrored text will not appear correctly
		   in the geda schematic, to make this work properly
		   will require some interesting math, but I don't think
		   there is much benefit to this

		6) Arcs in viewlogic are stored implicitly as a record
		   where the arc passes through three points,
		   the conversion from this format to geda's
		   center/radius/start/stop notation is not exact,
		   so some arcs may not render well.

		7) Bubbles are drawn on pins that are negated.	I believe
		   the code is correct, but have not tried all the
		   end cases.

		8) Rotated and mirrored components may not show up correctly.

	convert_sym.awk typical use:

		cat viewlogic_file | awk -f convert_sym.awk > geda_file

	convert_sym.awk is NOT installed when make install is run.

	convert_sym (the C version) typical use:

		./convert_sym viewlogic_filename > geda_file

	convert_sym is installed when make install is run.

		

- License  

	gEDA (includes gschem/gnetlist/geda/gsymcheck/gschcheck/gpcb/utils
	and all associated files (such as component symbols)) is placed
	under the GNU Public License (GPL) version 2.0.  See the toplevel
	COPYING file for more information.

	Programs and associated files are:
	Copyright 1998,1999 by Ales V. Hvezda and the respective original
	authors (which are listed on the respective files)

	mk_sym is Copyright 1999 by Jerry O'Keefe
	smash_megafile is Copyright 1999 by Mike Jarabek



- Contact information  

	Jerry O'Keefe (for mk_sym)
	E-mail: jerryok@pacbell.net

	Mike Jarabek (for smash_megafile, convert_sym.awk, convert_sym.c)
	E-mail: mjarabek@playground.net

	Ales V. Hvezda 
	E-mail: ahvezda@geda.seul.org
	Web: http://www.geda.seul.org/

