mirror of
				https://github.com/cclassic/model-ghdl
				synced 2025-11-04 02:49:33 +01:00 
			
		
		
		
	More doc
This commit is contained in:
		
							
								
								
									
										43
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										43
									
								
								README.md
									
									
									
									
									
								
							@@ -3,29 +3,56 @@ model-ghdl
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
A wrapper for GHDL to make it look like Mentor's ModelSim. Helpful for use with programs like Sigasi.
 | 
					A wrapper for GHDL to make it look like Mentor's ModelSim. Helpful for use with programs like Sigasi.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Compiling and use
 | 
				
			||||||
 | 
					-----------------
 | 
				
			||||||
 | 
					First install ghdl from [ghdl-updates](https://sourceforge.net/projects/ghdl-updates/). Model-ghdl expects to find the ghdl executable in the $PATH.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Then, to compile the wrapper, simply do the following:
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					git clone <git-url>
 | 
				
			||||||
 | 
					cmake .
 | 
				
			||||||
 | 
					make
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					The five modelsim applications should now be present in the current folder as symlinks along with a model-ghdl binary. Either install these into your path or point your IDE to the location of the files.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
VCOM
 | 
					VCOM
 | 
				
			||||||
----
 | 
					----
 | 
				
			||||||
### Original commands
 | 
					### Original commands
 | 
				
			||||||
* -work <top>: Set top level
 | 
					* -work *top*: Set top level
 | 
				
			||||||
* -workdir <dir>: Set working directory
 | 
					* -workdir *dir*: Set working directory
 | 
				
			||||||
* -87, -93, -93c, -2000, -2002, -2008: Set VHDL version
 | 
					* -87, -93, -93c, -2000, -2002, -2008: Set VHDL version
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Additional commands
 | 
					### Additional commands
 | 
				
			||||||
* -ghdl <param>: Supply these arguments directly to GHDL (can be used multiple times)
 | 
					* -ghdl *param*: Supply these arguments directly to GHDL (can be used multiple times)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Notes
 | 
					### Notes
 | 
				
			||||||
* cwd is expected to be the compile directory
 | 
					* *cwd* is expected to be the compile directory
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
VSIM
 | 
					VSIM
 | 
				
			||||||
----
 | 
					----
 | 
				
			||||||
### Original commands
 | 
					### Original commands
 | 
				
			||||||
* -gui work.toplevel(RTL): Set toplevel and work library
 | 
					* -gui *work.toplevel(RTL)*: Set toplevel and work library
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Additional commands
 | 
					### Additional commands
 | 
				
			||||||
* -ghdl <param>: Supply these arguments directly to GHDL (can be used multiple times)
 | 
					* -ghdl *param*: Supply these arguments directly to GHDL (can be used multiple times)
 | 
				
			||||||
* -gtkwprefix: Prefix for the .gtkw save file. Path will be $cwd/$prefix$toplevel.gtkw
 | 
					* -gtkwprefix *prefix*: Prefix for the .gtkw save file. Path will be $cwd/$prefix$toplevel.gtkw
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Notes
 | 
					### Notes
 | 
				
			||||||
* cwd is expected to be the source directory (used for .gtkw save path)
 | 
					* *cwd* is expected to be the source directory (used for .gtkw save path)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					VMAP
 | 
				
			||||||
 | 
					----
 | 
				
			||||||
 | 
					No function.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					VLIB
 | 
				
			||||||
 | 
					----
 | 
				
			||||||
 | 
					No function.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					VDEL
 | 
				
			||||||
 | 
					----
 | 
				
			||||||
 | 
					No function.
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user