index.md

Hardcaml Documentation

Welcome to Hardcaml!

Getting Started

Introducing the key modules and concepts in Hardcaml.

• Introduction
• Installing the open source package
• Combinational logic
• Sequential logic
• Naming
• Always API
• Instantiation
• Circuits
• Generating RTL
• Simulation
• Waveforms

See the serial multiplier for an example of using many of these features.

Using Hardcaml

Some more advanced concepts useful for designing and testing larger, more complex hardware designs.

• Hardcaml interfaces
• Module hierarchies
• Simulating with interfaces
• Writing state machines
• Enums in Hardcaml
• Interactive waveforms

Examples

• Simple counter
• Serial multiplier
• Calculating Fibonacci numbers

Libraries

• Accelerated Simulation Backends