Piplin documentation is organized as a number of guides, covering all kinds of topics.
All of these guides assume that your namespace looks like this:
(ns piplin.guide-contents (:refer-clojure :as clj :exclude [not= bit-or bit-xor + - * bit-and inc dec bit-not < > <= >= = cast not cond condp and or bit-shift-left bit-shift-right pos? neg? zero?]) (:use piplin.core plumbing.core))
We recommend that you read these guides, if possible, in this order:
An overview of Piplin with a quick tutorial that helps you to get started with it. It should take about 30 minutes to read and study the provided code examples
This guide explains how you can use the same functions and types at the REPL, in simulation, and in the generated Verilog. It goes over the simple and aggregate types and how they are constructed and interact.
An explanation of the Piplin module system. Goes over how to declare modules, how to incorpate state and feedback loops in your designs, and how to compose modules together to make more complex designs.
This is an API documentation guide, organized by functionality.
Please take a moment to tell us what you think about this guide on Twitter or the Piplin mailing list
Let us know what was unclear or what has not been covered. Maybe you do not like the guide style or grammar or discover spelling mistakes. Reader feedback is key to making the documentation better.