diff --git a/README.md b/README.md index 24bbd01..0b4114d 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@ ## Manta: An In-Situ Debugging Tool for Programmable Hardware ![functional_sim](https://github.com/fischermoseley/manta/actions/workflows/functional_sim.yml/badge.svg) +![build_examples](https://github.com/fischermoseley/manta/actions/workflows/build_examples.yml/badge.svg) +![build_docs](https://github.com/fischermoseley/manta/actions/workflows/build_docs.yml/badge.svg) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -Manta is a tool for debugging FPGA designs over an interface like UART or Ethernet. It works by allowing the user to instantiate a number of debug cores in a design, and exposes a Python interface to them. This permits rapid prototyping of logic in Python, and a means of incrementally migrating it to HDL. The cores are described below. - -Manta is written in Python, and generates Verilog-2001 HDL. It's cross-platform, and its only dependencies are pySerial and pyYAML. +Manta is a tool for getting information into and out of FPGAs over an interface like UART or Ethernet. It's primarily intended for debugging, but it's robust enough to be a simple, reliable transport layer between a FPGA and a host machine. It lets you configure a series of cores on a shared bus via a YAML or JSON file, and then provides a Python API to each core, along with vendor-agnostic Verilog HDL to instantiate them on your FPGA. For more information check out the docs: [https://fischermoseley.github.io/manta](https://fischermoseley.github.io/manta) \ No newline at end of file