The Spade Book

Spade is a Hardware Description Language inspired by modern software languages. Its strong type system, zero cost abstractions around common hardware constructs, and helpful compiler help you easily build complex hardware.

This book has a few different entry points depending on how you want to learn:

Guided Tutorial

This guide walks you through the language in a guided way and is the best way to get a complete overview of the language.

Example Project

This project shows the language in action without going into detail about every construct. This is useful if you have some Rust and hardware experience.

Online Playground

This lets you write and test Spade in the online playground without installing anything.

Install Spade

This shows you how to install the compiler and associated tools locally.

As you use the language, these resources will also come in handy:

Standard Library Documentation

Contains API level documentation for the standard library included in every project.

Reef - The Spade Package Index

Contains a list of community Spade libraries, along with their documentation.