This is a place to share libraries and utilities that don't belong (or don't yet belong) in the core bsc repository.
Files can be installed in the same way as in the bsc repository:
$ make PREFIX=/tools/bluespec
If the PREFIX variable is not specified, the default is inst.
Each set of libraries is installed into its own subdirectory, so that they are not in the path by default, but instead are only available when explicitly added on the command line:
$ bsc -p +:%/Libraries/FPGA/Xilinx/
Until a more sophisicated library system is available, this repository
can be used for sharing useful code. Contributions are welcome.
No guarantees are made about the quality of this code.
Tests for some libraries can be found in the testing directory.
The directory testing/bsc.contrib contains tests that can be run
using the testing infrastructure of the bsc repository.
Simply copy the directory to a clone of that repo, set
BSCCONTRIBDIR in the environment to point to the installation
to be tested, and run the testsuite as usual:
$ cp -r testing/bsc.contrib /path/to/bsc/testsuite/
$ cd /path/to/bsc/testsuite/bsc.contrib/
$ export BSCCONTRIBDIR=/path/to/bsc-contrib/inst
$ make check
Individual contributions are responsible for specifying their own
copyright and license. Libraries provided by Bluespec Inc have a
header comment that states the copyright and the license as an SPDX
short identifier (BSD-3-Clause) with the full license text given in
the LICENSES directory.
Please see the following document in the doc directory for advice on
how to contribute new libraries to this repository.