Skip to content

Commit

Permalink
Commentary on installation.
Browse files Browse the repository at this point in the history
  • Loading branch information
wsnyder committed May 3, 2020
1 parent cabbc1e commit 3b9b24f
Showing 1 changed file with 26 additions and 42 deletions.
68 changes: 26 additions & 42 deletions README.pod
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,8 @@ as a data structure, but does not interconnect the AST nodes as would be
needed to follow signals. Not all keywords have been implemented; many are
parsed but otherwise ignored. A complete Ast tree would allow any
arbitrary transformation of Verilog syntax (everything is known excluding
whitespace). Long term the authors would be interested in collaborating on
a general parser, but for now, applications can leverate the C++ code or
use Verilator's XML output (below).
whitespace). For these applications consider Verilator's XML output
(below).

=item Verilog::SigParser

Expand Down Expand Up @@ -222,60 +221,45 @@ design. It's also in very common usage, including by many IP providers.

Skip this section if Verilog-Perl has already been installed.

=head2 Supported Systems

Verilog-Perl should run on any system with Perl, G++, Flex, and Bison. It
is known to work on at least:

=over 4

=item * sparc-sun-solaris2.5.1

=item * i386-linux
is known to work on most Linux distributions, plus Cygwin.

=item * i686-w2k-cygwin

=back
You may install using either CPAN, or the sources. If you plan to do any
development on Verilog-Perl, use the sources.

=head2 CPAN Installation

=over 4

Easiest installation is using the "CPAN" command line that comes with Perl.
After configuring CPAN the first time, simply
Option 1: Easiest installation is using the "CPAN" command line that comes
with Perl. After configuring CPAN the first time, simply

$ cpan
cpan> install Verilog-Perl
cpan install Verilog-Perl
# And see the documentation
man Verilog-Perl
# Or, sometimes the capitalization is changed
man verilog-perl

Read the rest of this file for details on the programs provided.

=back

=head2 Manual Installation

=over 4

Download the latest version from L<http://www.perl.org/CPAN/>, or
from L<https://www.veripool.org/verilog-perl>.
=head2 Manual Installation from Repository

C<cd> to the directory containing this README notice.
Option 2: Build any version using the source development repository with:

Type C<perl Makefile.PL> to configure Verilog for your system.
git clone http://git.veripool.org/git/Verilog-Perl # Only first time
cd Verilog-Perl
git pull # Make sure we're up-to-date
git tag # See what versions exist (recent GITs only)
#git checkout master # Use development branch (e.g. recent bug fix)
#git checkout stable # Use most recent release
#git checkout v{version} # Switch to specified release version

Type C<make> to compile Verilog. Some Solaris users have had
trouble with "open" being redefined. If this happens, try editing
the Makefile to change _FILE_OFFSET_BITS to 32 instead of 64.

Type C<make test> to check the package. If you don't have
Synopsys' VCS, the test will print a warning, which you can ignore.

Type C<make install> to install the programs and any data files and
documentation.
perl Makefile.PL
# Ignore warning about README, this file will be generated
make
make test
make install

Read the rest of this file for details on the programs provided.

=back

=head1 FAQ

=over 4
Expand Down

0 comments on commit 3b9b24f

Please sign in to comment.