geda/README

   1 gEDA
   2
   3 GPL Electronic Design Automation
   4 ------------------------------------------------------------------------------
   5
   6 README for Project Manager
   7
   8
   9 gEDA Suite Project Manager is a start point for everything what you may
  10 want to do. It is used to organize your files and easy running tools. It
  11 simplifies your job.
  12
  13 There is a menu at the top of the window. Main area of Project Manager
  14 window is divided into three parts:
  15
  16         * Project Browser - there are your files enumerated here. In a
  17           Modules view you can see project hierarchy, in a Files view -
  18           files sorted in disk folders.
  19
  20         * Workspace - there are your files opened here. Listing of opened
  21           files is shown under Window menu.
  22
  23         * Status Area - effects of your actions will be shown here.
  24
  25 gEDA Suite is strongly project oriented. It means that you cannot work
  26 with files without creating a project. To force it, workspace and status
  27 area are inactive when no project is loaded.
  28
  29 If you have a project saved on the disk, choose Project -> Open. A
  30 new dialog window - File Selection -will be opened. Choose a directory
  31 where project files is stored, click or type a name of the project file,
  32 then press Ok.
  33
  34 To create a new project choose Project -> New from the menu. A new dialog
  35 window - File Selection -will be opened. Choose a desired directory where
  36 project files should be stored, a name of the new project file, then press
  37 Ok. The name has to be ended with .prj. The new project should be created.
  38
  39 Now the project is opened, its name is displayed in a title bar and
  40 menus are activated. You can add, remove, open, etc. files.
  41
  42 Some of those actions can modify your project, then an asteriks * will
  43 be added to the project name on the title bar. It informs you that you
  44 have to save the project choosing Project -> Save from the menu. If
  45 you try to close the project or exit Project Manager without saving,
  46 a warning will be displayed.
  47
  48 After completing your job please close the project choosing Project ->
  49 Close from the menu.
  50
  51 If a project is opened, you can add files to the project and work with
  52 them.  Only files of registered types can be added. For any of them a set
  53 of possible actions is defined. There are also some file types generated
  54 and imported automatically after running actions. They cannot be added
  55 manually to the project.
  56
  57 All registered files types are listed below:
  58
  59 --------------------------------------------------------------------------------
  60
  61 FILE TYPE   EXT.    ACTIONS                          IMPORT  CREATION
  62
  63 --------------------------------------------------------------------------------
  64
  65 Text        *.txt   Open                                     File -> New
  66
  67 Schematic   *.sch   Open                                     File -> New
  68                     Create PCB layout                *.pcb
  69                     Create SPICE netlist             *.cir
  70                     Create Verilog source            *.v
  71                     Create VHDL source               *.vhd
  72                     Design rule checking (DRC)       *.drc
  73                     Create bill of materials (BOM)   *.bom
  74
  75 PCB layout  *.pcb   Open                                     File -> New or
  76                                                              generated from
  77                                                              schematic
  78
  79 SPICE       *.cir   Open                                     File -> New or
  80 netlist             Simulate                         *.gw    generated from
  81                                                              schematic
  82
  83 Verilog     *.v     Open                                     File -> New or
  84 source              Simulate                         *.vcd   generated from
  85                     Synthesize                       *.xnf   schematic
  86
  87 VHDL source *.vhd   Open                                     Generated from
  88                                                              schematic
  89
  90 Gerber file *.grb   Open                                     Generated in PCB
  91
  92 Analog      *.gw    Open                                     Generated from
  93 waveform                                                     SPICE netlist.
  94
  95 Digital     *.vcd   Open                                     Generated from
  96 waveform                                                     Verilog source
  97
  98 DRC report  *.drc   Open                                     Generated from
  99                                                              schematic
 100
 101 BOM report  *.bom   Open                                     Generated from
 102                                                              schematic
 103
 104 Xilinx XNF  *.xnf                                            Generated from
 105                                                              Verilog source
 106
 107 --------------------------------------------------------------------------------
 108
 109 To add a new file to the project choose File -> New, then select a type of
 110 added file. To add an existing file choose File -> Import. In both cases
 111 a new dialog - File Selection - will be opened. Go to desired directory,
 112 then click or type a name of the file, then press Ok. Remeber that the
 113 file has to have its extension as mentioned in the table above!
 114
 115 To remove a file from the project, click its name in Project Browser
 116 and choose File -> Unlink from the menu. The file will stay on the
 117 disk. To completely delete the file, choose File -> Delete. In both
 118 cases a warning will be displayed.
 119
 120 Files selected in Project Browser can be opened, edited and used for other
 121 actions. Majority of files are ASCII ones. They can be edited as a text
 122 in builtin text editor. To edit a file choose File -> Edit from the menu.
 123
 124 To open a file select it in Project Browser, then choose Action -> Open
 125 form the menu. You can double click the file in Project Browser as well.
 126
 127 Files can be opened in internal or external tools. If an internal one is
 128 used - the file will be displayed as a new window in the Workspace. If
 129 external one is used - a new tool will be runned. All opened files are
 130 listed in Window menu.  You can switch between internally opened windows
 131 choosing its name in the Window menu.
 132
 133 To close an internally opened file - choose it from the Window menu,
 134 then choose File -> Close. If the file is modified and not saved,
 135 a warning will be displayed.
 136
 137 Files opened and modified should be saved with File -> Save. A file
 138 currently opened in the workspace will be saved.
 139