Merge pull request #1020 from DeflateAwning/install-update-1
Update INSTALL to refer to better instructions for this project
This commit is contained in:
Cary R
GitHub
commit
b1006b3848
182
INSTALL
182
INSTALL
|
|
@ -1,52 +1,59 @@
|
|||
Basic Installation
|
||||
==================
|
||||
|
||||
These are generic installation instructions.
|
||||
These are generic installation instructions, with minor updates
|
||||
for the `iverilog` project.
|
||||
|
||||
The `configure' shell script attempts to guess correct values for
|
||||
Instructions in the `README` are more concise for this project.
|
||||
|
||||
The `configure` shell script attempts to guess correct values for
|
||||
various system-dependent variables used during compilation. It uses
|
||||
those values to create a `Makefile' in each directory of the package.
|
||||
It may also create one or more `.h' files containing system-dependent
|
||||
definitions. Finally, it creates a shell script `config.status' that
|
||||
those values to create a `Makefile` in each directory of the package.
|
||||
It may also create one or more `.h` files containing system-dependent
|
||||
definitions. Finally, it creates a shell script `config.status` that
|
||||
you can run in the future to recreate the current configuration, a file
|
||||
`config.cache' that saves the results of its tests to speed up
|
||||
reconfiguring, and a file `config.log' containing compiler output
|
||||
(useful mainly for debugging `configure').
|
||||
`config.cache` that saves the results of its tests to speed up
|
||||
reconfiguring, and a file `config.log` containing compiler output
|
||||
(useful mainly for debugging `configure`).
|
||||
|
||||
If you need to do unusual things to compile the package, please try
|
||||
to figure out how `configure' could check whether to do them, and mail
|
||||
diffs or instructions to the address given in the `README' so they can
|
||||
be considered for the next release. If at some point `config.cache'
|
||||
to figure out how `configure` could check whether to do them, and mail
|
||||
diffs or instructions to the address given in the `README` so they can
|
||||
be considered for the next release. If at some point `config.cache`
|
||||
contains results you don't want to keep, you may remove or edit it.
|
||||
|
||||
The file `configure.ac' is used to create `configure' by a program
|
||||
called `autoconf'. You only need `configure.ac' if you want to change
|
||||
it or regenerate `configure' using a newer version of `autoconf'.
|
||||
The file `configure.ac` is used to create `configure` by a program
|
||||
called `autoconf`. You only need `configure.ac` if you want to change
|
||||
it or regenerate `configure` using a newer version of `autoconf`.
|
||||
|
||||
The simplest way to compile this package is:
|
||||
|
||||
1. `cd' to the directory containing the package's source code and type
|
||||
`./configure' to configure the package for your system. If you're
|
||||
using `csh' on an old version of System V, you might need to type
|
||||
`sh ./configure' instead to prevent `csh' from trying to execute
|
||||
`configure' itself.
|
||||
1. `cd` to the directory containing the package's source code.
|
||||
|
||||
2. Run `sh autoconf.sh`, if building from source (and not a release).
|
||||
If you're building from a release, skip this step.
|
||||
|
||||
Running `configure' takes awhile. While running, it prints some
|
||||
3. Run `./configure` to configure the package for your system. If you're
|
||||
using `csh` on an old version of System V, you might need to type
|
||||
`sh ./configure` instead to prevent `csh` from trying to execute
|
||||
`configure` itself.
|
||||
|
||||
Running `configure` takes awhile. While running, it prints some
|
||||
messages telling which features it is checking for.
|
||||
|
||||
2. Type `make' to compile the package.
|
||||
4. Type `make` to compile the package.
|
||||
|
||||
3. Optionally, type `make check' to run any self-tests that come with
|
||||
5. Optionally, type `make check` to run any self-tests that come with
|
||||
the package.
|
||||
|
||||
4. Type `make install' to install the programs and any data files and
|
||||
documentation.
|
||||
6. Type `make install` to install the programs and any data files and
|
||||
documentation. You may need to use `sudo`.
|
||||
|
||||
5. You can remove the program binaries and object files from the
|
||||
source code directory by typing `make clean'. To also remove the
|
||||
files that `configure' created (so you can compile the package for
|
||||
a different kind of computer), type `make distclean'. There is
|
||||
also a `make maintainer-clean' target, but that is intended mainly
|
||||
7. You can remove the program binaries and object files from the
|
||||
source code directory by typing `make clean`. To also remove the
|
||||
files that `configure` created (so you can compile the package for
|
||||
a different kind of computer), type `make distclean`. There is
|
||||
also a `make maintainer-clean` target, but that is intended mainly
|
||||
for the package's developers. If you use it, you may have to get
|
||||
all sorts of other programs in order to regenerate files that came
|
||||
with the distribution.
|
||||
|
|
@ -55,126 +62,131 @@ Compilers and Options
|
|||
=====================
|
||||
|
||||
Some systems require unusual options for compilation or linking that
|
||||
the `configure' script does not know about. You can give `configure'
|
||||
the `configure` script does not know about. You can give `configure`
|
||||
initial values for variables by setting them in the environment. Using
|
||||
a Bourne-compatible shell, you can do that on the command line like
|
||||
this:
|
||||
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
|
||||
|
||||
Or on systems that have the `env' program, you can do it like this:
|
||||
```bash
|
||||
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
|
||||
```
|
||||
|
||||
Or on systems that have the `env` program, you can do it like this:
|
||||
```bash
|
||||
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
|
||||
```
|
||||
|
||||
Compiling For Multiple Architectures
|
||||
====================================
|
||||
|
||||
You can compile the package for more than one kind of computer at the
|
||||
same time, by placing the object files for each architecture in their
|
||||
own directory. To do this, you must use a version of `make' that
|
||||
supports the `VPATH' variable, such as GNU `make'. `cd' to the
|
||||
own directory. To do this, you must use a version of `make` that
|
||||
supports the `VPATH` variable, such as GNU `make`. `cd` to the
|
||||
directory where you want the object files and executables to go and run
|
||||
the `configure' script. `configure' automatically checks for the
|
||||
source code in the directory that `configure' is in and in `..'.
|
||||
the `configure` script. `configure` automatically checks for the
|
||||
source code in the directory that `configure` is in and in `..`.
|
||||
|
||||
If you have to use a `make' that does not supports the `VPATH'
|
||||
If you have to use a `make` that does not supports the `VPATH`
|
||||
variable, you have to compile the package for one architecture at a time
|
||||
in the source code directory. After you have installed the package for
|
||||
one architecture, use `make distclean' before reconfiguring for another
|
||||
one architecture, use `make distclean` before reconfiguring for another
|
||||
architecture.
|
||||
|
||||
Installation Names
|
||||
==================
|
||||
|
||||
By default, `make install' will install the package's files in
|
||||
`/usr/local/bin', `/usr/local/man', etc. You can specify an
|
||||
installation prefix other than `/usr/local' by giving `configure' the
|
||||
option `--prefix=PATH'.
|
||||
By default, `make install` will install the package's files in
|
||||
`/usr/local/bin`, `/usr/local/man`, etc. You can specify an
|
||||
installation prefix other than `/usr/local` by giving `configure` the
|
||||
option `--prefix=PATH`.
|
||||
|
||||
You can specify separate installation prefixes for
|
||||
architecture-specific files and architecture-independent files. If you
|
||||
give `configure' the option `--exec-prefix=PATH', the package will use
|
||||
give `configure` the option `--exec-prefix=PATH`, the package will use
|
||||
PATH as the prefix for installing programs and libraries.
|
||||
Documentation and other data files will still use the regular prefix.
|
||||
|
||||
In addition, if you use an unusual directory layout you can give
|
||||
options like `--bindir=PATH' to specify different values for particular
|
||||
kinds of files. Run `configure --help' for a list of the directories
|
||||
options like `--bindir=PATH` to specify different values for particular
|
||||
kinds of files. Run `configure --help` for a list of the directories
|
||||
you can set and what kinds of files go in them.
|
||||
|
||||
If the package supports it, you can cause programs to be installed
|
||||
with an extra prefix or suffix on their names by giving `configure' the
|
||||
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
|
||||
with an extra prefix or suffix on their names by giving `configure` the
|
||||
option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`.
|
||||
|
||||
Optional Features
|
||||
=================
|
||||
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
`configure', where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
|
||||
is something like `gnu-as' or `x' (for the X Window System). The
|
||||
`README' should mention any `--enable-' and `--with-' options that the
|
||||
Some packages pay attention to `--enable-FEATURE` options to
|
||||
`configure`, where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE` options, where PACKAGE
|
||||
is something like `gnu-as` or `x` (for the X Window System). The
|
||||
`README` should mention any `--enable-` and `--with-` options that the
|
||||
package recognizes.
|
||||
|
||||
For packages that use the X Window System, `configure' can usually
|
||||
For packages that use the X Window System, `configure` can usually
|
||||
find the X include and library files automatically, but if it doesn't,
|
||||
you can use the `configure' options `--x-includes=DIR' and
|
||||
`--x-libraries=DIR' to specify their locations.
|
||||
you can use the `configure` options `--x-includes=DIR` and
|
||||
`--x-libraries=DIR` to specify their locations.
|
||||
|
||||
Specifying the System Type
|
||||
==========================
|
||||
|
||||
There may be some features `configure' can not figure out
|
||||
There may be some features `configure` can not figure out
|
||||
automatically, but needs to determine by the type of host the package
|
||||
will run on. Usually `configure' can figure that out, but if it prints
|
||||
will run on. Usually `configure` can figure that out, but if it prints
|
||||
a message saying it can not guess the host type, give it the
|
||||
`--host=TYPE' option. TYPE can either be a short name for the system
|
||||
type, such as `sun4', or a canonical name with three fields:
|
||||
CPU-COMPANY-SYSTEM
|
||||
`--host=TYPE` option. TYPE can either be a short name for the system
|
||||
type, such as `sun4`, or a canonical name with three fields:
|
||||
`CPU-COMPANY-SYSTEM`
|
||||
|
||||
See the file `config.sub' for the possible values of each field. If
|
||||
`config.sub' isn't included in this package, then this package doesn't
|
||||
See the file `config.sub` for the possible values of each field. If
|
||||
`config.sub` isn't included in this package, then this package doesn't
|
||||
need to know the host type.
|
||||
|
||||
If you are building compiler tools for cross-compiling, you can also
|
||||
use the `--target=TYPE' option to select the type of system they will
|
||||
produce code for and the `--build=TYPE' option to select the type of
|
||||
use the `--target=TYPE` option to select the type of system they will
|
||||
produce code for and the `--build=TYPE` option to select the type of
|
||||
system on which you are compiling the package.
|
||||
|
||||
Sharing Defaults
|
||||
================
|
||||
|
||||
If you want to set default values for `configure' scripts to share,
|
||||
you can create a site shell script called `config.site' that gives
|
||||
default values for variables like `CC', `cache_file', and `prefix'.
|
||||
`configure' looks for `PREFIX/share/config.site' if it exists, then
|
||||
`PREFIX/etc/config.site' if it exists. Or, you can set the
|
||||
`CONFIG_SITE' environment variable to the location of the site script.
|
||||
A warning: not all `configure' scripts look for a site script.
|
||||
If you want to set default values for `configure` scripts to share,
|
||||
you can create a site shell script called `config.site` that gives
|
||||
default values for variables like `CC`, `cache_file`, and `prefix`.
|
||||
`configure` looks for `PREFIX/share/config.site` if it exists, then
|
||||
`PREFIX/etc/config.site` if it exists. Or, you can set the
|
||||
`CONFIG_SITE` environment variable to the location of the site script.
|
||||
A warning: not all `configure` scripts look for a site script.
|
||||
|
||||
Operation Controls
|
||||
==================
|
||||
|
||||
`configure' recognizes the following options to control how it
|
||||
`configure` recognizes the following options to control how it
|
||||
operates.
|
||||
|
||||
`--cache-file=FILE'
|
||||
`--cache-file=FILE`
|
||||
Use and save the results of the tests in FILE instead of
|
||||
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
|
||||
debugging `configure'.
|
||||
`./config.cache`. Set FILE to `/dev/null` to disable caching, for
|
||||
debugging `configure`.
|
||||
|
||||
`--help'
|
||||
Print a summary of the options to `configure', and exit.
|
||||
`--help`
|
||||
Print a summary of the options to `configure`, and exit.
|
||||
|
||||
`--quiet'
|
||||
`--silent'
|
||||
`-q'
|
||||
`--quiet`
|
||||
`--silent`
|
||||
`-q`
|
||||
Do not print messages saying which checks are being made.
|
||||
|
||||
`--srcdir=DIR'
|
||||
`--srcdir=DIR`
|
||||
Look for the package's source code in directory DIR. Usually
|
||||
`configure' can determine that directory automatically.
|
||||
`configure` can determine that directory automatically.
|
||||
|
||||
`--version'
|
||||
Print the version of Autoconf used to generate the `configure'
|
||||
`--version`
|
||||
Print the version of Autoconf used to generate the `configure`
|
||||
script, and exit.
|
||||
|
||||
`configure' also accepts some other, not widely useful, options.
|
||||
`configure` also accepts some other, not widely useful, options.
|
||||
|
|
|
|||
55
README.md
55
README.md
|
|
@ -59,7 +59,10 @@ not required, but helpful in case of problems.
|
|||
|
||||
### Compile Time Prerequisites
|
||||
|
||||
You can use: `apt install -y autoconf gperf make gcc g++ bison flex`
|
||||
You can use:
|
||||
```bash
|
||||
apt install -y autoconf gperf make gcc g++ bison flex`
|
||||
```
|
||||
|
||||
You need the following software to compile Icarus Verilog from source
|
||||
on a UNIX-like system:
|
||||
|
|
@ -109,26 +112,25 @@ on a UNIX-like system:
|
|||
### Compilation
|
||||
|
||||
<details>
|
||||
<summary><h4><a href="https://github.com/steveicarus/iverilog/releases">From Release</a></h4></summary>
|
||||
<summary><h4><a href="https://github.com/steveicarus/iverilog/releases">Compiling From Release</a></h4></summary>
|
||||
|
||||
Unpack the tar-ball and cd into the `verilog-#########` directory
|
||||
(presumably, that is how you got to this README) and compile the source
|
||||
with the commands:
|
||||
Unpack the tar-ball, `cd` into the `verilog-#########` directory,
|
||||
and compile the source with the commands:
|
||||
|
||||
```
|
||||
```bash
|
||||
./configure
|
||||
make
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><h4>From GitHub</h4></summary>
|
||||
<summary><h4>Compiling From GitHub</h4></summary>
|
||||
|
||||
If you are building from git, you have to run the command below before
|
||||
compiling the source. This will generate the "configure" file, which is
|
||||
automatically done when building from tarball.
|
||||
|
||||
```
|
||||
```bash
|
||||
sh autoconf.sh
|
||||
./configure
|
||||
make
|
||||
|
|
@ -172,7 +174,7 @@ configure script that modify its behaviour:
|
|||
|
||||
To run a simple test before installation, execute
|
||||
|
||||
```
|
||||
```bash
|
||||
make check
|
||||
```
|
||||
|
||||
|
|
@ -187,7 +189,7 @@ default install in /usr/local unless you specify a different prefix
|
|||
with the `--prefix=<path>` flag to the configure command.) You may need
|
||||
to do this as root to gain access to installation directories.
|
||||
|
||||
```
|
||||
```bash
|
||||
make install
|
||||
```
|
||||
|
||||
|
|
@ -207,11 +209,11 @@ switches.
|
|||
|
||||
### Preprocessing
|
||||
|
||||
There is a separate program, ivlpp, that does the preprocessing. This
|
||||
There is a separate program, `ivlpp`, that does the preprocessing. This
|
||||
program implements the `` `include `` and `` `define `` directives producing
|
||||
output that is equivalent but without the directives. The output is a
|
||||
single file with line number directives, so that the actual compiler
|
||||
only sees a single input file. See ivlpp/ivlpp.txt for details.
|
||||
only sees a single input file. See `ivlpp/ivlpp.txt` for details.
|
||||
|
||||
### Parse
|
||||
|
||||
|
|
@ -331,31 +333,32 @@ attributes. They have the same general meaning as with the $attribute
|
|||
syntax, but they are attached to objects by position instead of by
|
||||
name. Also, the key is a Verilog identifier instead of a string.
|
||||
|
||||
## Running iverilog
|
||||
## Running `iverilog`
|
||||
|
||||
The preferred way to invoke the compiler is with the `iverilog`(1)
|
||||
command. This program invokes the preprocessor (ivlpp) and the
|
||||
command. This program invokes the preprocessor (`ivlpp`) and the
|
||||
compiler (`ivl`) with the proper command line options to get the job
|
||||
done in a friendly way. See the `iverilog`(1) man page for usage details.
|
||||
|
||||
|
||||
### EXAMPLES
|
||||
### EXAMPLE: Hello World
|
||||
|
||||
Example: Compiling `"hello.vl"`
|
||||
|
||||
```
|
||||
------------------------ hello.vl ----------------------------
|
||||
```verilog
|
||||
// ------------------------ hello.vl ----------------------------
|
||||
|
||||
module main();
|
||||
|
||||
initial
|
||||
begin
|
||||
$display("Hi there");
|
||||
$display("Hello World");
|
||||
$finish ;
|
||||
end
|
||||
|
||||
endmodule
|
||||
|
||||
--------------------------------------------------------------
|
||||
// --------------------------------------------------------------
|
||||
```
|
||||
|
||||
Ensure that `iverilog` is on your search path, and the vpi library
|
||||
|
|
@ -363,16 +366,16 @@ is available.
|
|||
|
||||
To compile the program:
|
||||
|
||||
```
|
||||
```bash
|
||||
iverilog hello.vl
|
||||
```
|
||||
|
||||
(The above presumes that /usr/local/include and /usr/local/lib are
|
||||
part of the compiler search path, which is usually the case for gcc.)
|
||||
(The above presumes that `/usr/local/include` and `/usr/local/lib` are
|
||||
part of the compiler search path, which is usually the case for `gcc`.)
|
||||
|
||||
To run the program:
|
||||
To run the generated program:
|
||||
|
||||
```
|
||||
```bash
|
||||
./a.out
|
||||
```
|
||||
|
||||
|
|
@ -536,12 +539,12 @@ and regs to be explicitly typed. The currently supported types
|
|||
are logic, bool and real. This implies that `logic` and `bool`
|
||||
are new keywords. Typical syntax is:
|
||||
|
||||
```
|
||||
```verilog
|
||||
wire real foo = 1.0;
|
||||
reg logic bar, bat;
|
||||
```
|
||||
... and so forth. The syntax can be turned off by using the
|
||||
-g2 flag to iverilog, and turned on explicitly with the -g2x
|
||||
`-g2` flag to iverilog, and turned on explicitly with the `-g2x`
|
||||
flag to iverilog.
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue