search

FPGAwars / apio

:seedling: Open source ecosystem for open FPGA boards
https://github.com/FPGAwars/apio/wiki
GNU General Public License v2.0
801 stars 137 forks source link

Updated the commands help texts. #413

Closed zapta closed 2 months ago

zapta commented 2 months ago

Each command has now both short and long click help texts, and the long text should be sufficient to understand how to user the command. Having the command documentation near the code will help keeping it current.

Also:

  1. The sim and test commands now accepts the testbench as an argument instead of a --testbench option.
  2. Some options where marked in the help text as "(deprecated)" though there is not change in their functionality.
  3. Fixed a broken boards.json format.

Here is an example of the help text of the build command.

$ apio build -h
Usage: apio build [OPTIONS]

  The build command reads the project source files and generates a bitstream
  file that you can uploaded to your FPGA. The commands is typically used in
  the root directory of the project that that contains the apio.ini file.

  Examples:
    apio build
    apio build -v

  [Note] The flags marked with (deprecated) are not recomanded. Instead, use
  an apio.ini project config file and if neaded, add to the project custom
  boards.json and fpga.json files.

Options:
  -p, --project-dir path  Set the root directory for the project.
  -v, --verbose           Show the entire output of the command.
  --verbose-yosys         Show the yosys output.
  --verbose-pnr           Show the pnr output.
  -t, --top-module name   (deprecated) Set the top level module name.
  -b, --board str         (deprecated) Set the board.
  --fpga str              (deprecated) Set the FPGA.
  --size str              (deprecated) Set the FPGA type (1k/8k).
  --type str              (deprecated) Set the FPGA type (hx/lp).
  --pack str              (deprecated) Set the FPGA package.
  -h, --help              Show this message and exit.