apio examples

Contents

• apio examples
  • Usage
  • Description
  • Options
  • Examples

Usage

apio examples [OPTIONS]

Description

Manage verilog examples: https://github.com/FPGAwars/apio-examples

This command requires the examples package.

Options

-l, --list

List all available examples.

-d, --dir

Copy the selected example directory.

-f, --files

Copy the selected example files.

-p, --project-dir

Set the target directory for the examples.

-n, --sayno

Automatically answer NO to all the questions.

Examples

1. Show all available examples

$ apio examples --list
[ ... ]

leds
---------------------------------------------------------------------------------------------
Verilog example for Turning all the leds on (for the icestick/icezum boards)

wire
---------------------------------------------------------------------------------------------
Verilog example on how to describe a simple wire

[ ...]

2. Copy the leds example files

$ apio examples --files leds
Copying leds example files ...
Example files 'leds' have been successfully created!

$ ls
leds.pcf  leds_tb.gtkw  leds_tb.v  leds.v

3. Copy the leds example directory

$ apio examples --dir leds
Creating leds directory ...
Example 'leds' has been successfully created!

$ tree leds
leds
├── info
├── leds.pcf
├── leds_tb.gtkw
├── leds_tb.v
└── leds.v