README.mdwn

   1 # Libre-SOC Reproducible Build Scripts
   2
   3 This repository contains the Libre-SOC "reproducible builds" scripts.
   4 Initially begun as a way to ensure that coriolis2 VLSI ASIC layouts
   5 were reproducible, they've turned into an easy way for developers to
   6 get started.
   7
   8 All packages are installed within a baseline debian/10 debootstrapped
   9 schroot.  For reproducible builds, you have to pick an OS, and debian/10
  10 is good enough
  11
  12 Prerequisites:
  13
  14 * Strongly recommended that you install a Host OS of Debian.
  15 * Confirmed working but not supported: ubuntu
  16 * Also confirmed working with a caveat on X11: archlinux,
  17   (which happens to have a port of debootstrap)
  18
  19 Installs (at recent but usually specific - reproducible - versions):
  20
  21 * coriolis2
  22 * yosys
  23 * symbiyosys, z3 solver, yices, sby
  24 * ghdl
  25 * yosys-ghdl
  26 * nextpnr-ecp5
  27 * nextpnr-xilinx
  28 * symbiflow
  29 * nmigen (a Registered Trademark of M-Labs)
  30 * verilator
  31 * icarus verilog
  32 * cocotb
  33 * a ton of FPGA loader tools, dfu-util, openFPGALoader, ecpprog,
  34   fujprog, and associated udev.d rules files.
  35
  36 Note: we don't use conda.  we don't use docker.
  37
  38 # Installation Notes
  39
  40 During their development, each install script had notes taken which,
  41 if followed carefully, should result in the replication of the script.
  42 These notes can be found here:
  43
  44 * <https://libre-soc.org/HDL_workflow/>
  45 * <https://libre-soc.org/HDL_workflow/coriolis2/>
  46 * <https://libre-soc.org/HDL_workflow/nextpnr/>
  47 * <https://libre-soc.org/HDL_workflow/nextpnr-xilinx/>
  48 * <https://libre-soc.org/HDL_workflow/verilator/>
  49 * <https://libre-soc.org/HDL_workflow/ghdl/>
  50 * <https://libre-soc.org/HDL_workflow/iverilog/>
  51 * <https://libre-soc.org/HDL_workflow/cocotb/>
  52 * <https://libre-soc.org/HDL_workflow/symbiflow/>
  53 * <https://libre-soc.org/HDL_workflow/fpga-boot-loaders-progs/>
  54
  55 # Contact details
  56
  57 Any questions, improvements, bug-fixes or patches, most welcome:
  58 please join Libera.Chat IRC #libre-soc, or join the mailing list:
  59 <https://lists.libre-soc.org/mailman/listinfo/libre-soc-dev>
  60
  61 # Charter
  62
  63 Covered by the Libre-SOC Charter <https://libre-soc.org/charter/discussion/>
  64 we particularly welcome appropriate Dilbert Cartoons illustrating the
  65 antithetical polar opposite of the points that make up the fundamental
  66 existential existence of the Charter. y'ken.