[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

gEDA-cvs: CVS update: Makefile.am



  User: sdb     
  Date: 05/08/16 13:05:14

  Modified:    .        Makefile.am
  Added:       .        README.grenum TODO.grenum why.grenum
  Log:
  Added grenum documentation.
  
  
  
  
  Revision  Changes    Path
  1.3       +2 -2      eda/geda/devel/utils/docs/Makefile.am
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Makefile.am
  ===================================================================
  RCS file: /home/cvspsrv/cvsroot/eda/geda/devel/utils/docs/Makefile.am,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -b -r1.2 -r1.3
  --- Makefile.am	7 Jan 2004 04:11:26 -0000	1.2
  +++ Makefile.am	16 Aug 2005 17:05:14 -0000	1.3
  @@ -1,8 +1,8 @@
   
  -EXTRA_DIST = README.gsch2pcb README.olib README.tragesym
  +EXTRA_DIST = README.gsch2pcb README.olib README.tragesym README.grenum TODO.grenum why.grenum
   
   docsreadmedir = @GEDADOCDIR@/readmes
  -docsreadme_DATA = README.gsch2pcb README.olib README.tragesym
  +docsreadme_DATA = README.gsch2pcb README.olib README.tragesym README.grenum
   
   MOSTLYCLEANFILES = *.log *~
   CLEANFILES = *.log *~ 
  
  
  
  1.1                  eda/geda/devel/utils/docs/README.grenum
  
  Index: README.grenum
  ===================================================================
  This  is  grenum,  an advanced refdes renumber utility for gEDA's
  gschem.
  
  
  INTRODUCTION
  
  This program renumbers the refdes  definitions  read  from  input
  file.
  
  GOALS
  
  There  is  another  script  called  refdes_renum comes with geda-
  utyls, but it does not care about slotted elements.  grenum  will
  not  renumber all refdeses, only, if a "?" is found in the refdes
  definition. After the first run, you have to edit the  refdes  of
  multi  slotted  elements, but after it, they won't be renumbered.
  Moreover, the text after the refdes numbers are ignored. This  is
  useful,  if  you  want  to have e.g. IC3a, IC3b components on the
  schematic. Unfortunately, the next layer, the gsch2pcb  does  not
  ignore this, and will create a new component (am I right?).
  
  As  it was mentioned grenum does not renumber refdeses which were
  already renumbered. However, it detects gaps between  the  refdes
  numbers.  For  example, if you have IC3 and IC6, it'll start num-
  bering new components from IC1 to IC2, and IC4-IC5 and after IC7.
  This  is essential, because gsch2pcb does not care about refdeses
  (which is good), and if  the  refdeses  gets  totally  renumbered
  (gaps filled totally), then all your components will shifted, and
  you have to move everything on your board.
  
  COMPILATION
  
  This is very very tiny program, needs no external libraries, just
  a  working C compiler. If your C compiler is not gcc, you have to
  edit the Makefile in the src directory.
  
  To untar the package, issue the command
  
  $ tar -jxvf grenum.tar.bz2
  
  Note that you need bunzip2 and the tar utility.
  
  To compile the code cd to the grenum directory and make the  exe-
  cutable
  
  $ cd grenum $ make
  
  To install the compiled executable (as root) issue
  
  # make install
  
  USAGE
  
  To renumber your gschem file issue
  
  $ grenum yourfile.sch
  
  for  more  information,  see the manpage, and read the documenta-
  tion, which you can't since I had no time  write  it.  But  it'll
  come... :-)
  
  CONTACT
  
  Please send comments to
  
          - levente.kovacs@xxxxxxxxxxxx
  
  
  
  1.1                  eda/geda/devel/utils/docs/TODO.grenum
  
  Index: TODO.grenum
  ===================================================================
  This is my to do list
  
  -test test test
  -file handling improvements
  -interworking with gaf's project file
  -integrate the code to gschem /*This would be the best*/
  
  Levente
  
  
  
  1.1                  eda/geda/devel/utils/docs/why.grenum
  
  Index: why.grenum
  ===================================================================
  Why I wrote this program?
  
  
  Well...  I wanted to make a distortion pedal for my guitar, and a
  guitar tuner, and an active crossover circuit for my power ampli-
  fiers.
  
  I was using gEDA and pcb for a long time, because my policy is to
  use GPLed softwares all around. At work, everyone  laugh  at  me,
  why I'm using such crap stuff. Of course, I don't agree with this
  statement.
  
  In the other hand, I can see real problems with gEDA/pcb. One  is
  (or I hope it was!) the refdes renumbering business.
  
  When I was starting to design my first project, the guitar tuner,
  I was using a dual opamp. It was okay, I said, every time I  make
  some change to the layout, I had to modify the schematic too, be-
  cause both two slot got a different  designator  by  running  the
  refdes_renum  script.  I said "okay, this is for free...". In the
  meantime, I was developing software for CERN, and I've found  out
  that  the computer is for us, and it is existed to help us. At my
  second project which is still ongoing, I had real pain to manual-
  ly  annotating everything. I've just could not live with the fact
  that we have a relatively well written schematic  capture,  which
  can't number parts.
  
  In my head, there was already thoughts about the crossover. I use
  Linkwitz-Relay filters, which consist of four opa. The final  de-
  sign  will consist of 20-30 dual operational amplifiers. One just
  can't keep track with all the slot information in a head. At that
  point, I've decided to do something about it.
  
  I  was  examining  the  source  of the refdes_renum script. No, I
  can't speak perl. I took my editor, and I spent two days front of
  my  computer,  and  I  did the grenum program, which likely helps
  solving this problem. This is written in C.
  
  I hope You will find it useful, and I hope one day this code will
  be  integrated into gschem. It would be another step to full for-
  ward/backward annotation of gschem and pcb.
  
  
  Levente Kovacs, the author.