Metadata-Version: 2.1
Name: corsair
Version: 0.2.0
Summary: Control and Status Register map generator for FPGA/ASIC projects
Home-page: https://github.com/esynr3z/corsair
Author: esynr3z
Author-email: esynr3z@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://corsair.readthedocs.io
Description: # Corsair
        
        [![Documentation Status](https://readthedocs.org/projects/corsair/badge/?version=latest)](https://corsair.readthedocs.io/en/latest/?badge=latest)
        ![PyTest Status](https://github.com/esynr3z/corsair/workflows/pytest/badge.svg)
        [![PyPI version](https://badge.fury.io/py/corsair.svg)](https://badge.fury.io/py/corsair)
        
        ![corsair_arch](https://raw.githubusercontent.com/esynr3z/corsair/master/docs/arch.svg)
        
        Corsair is a tool that makes it easy to organize and support control and status register (CSR) map for any FPGA/ASIC project.
        You just need to create and fill single CSR map description file once and then generate HDL code, headers, documentation and etc.
        
        It is as easy as:
        
        * Create CSR map description file or generate a template with Corsair:
        
        ```sh
        corsair --template-regmap regs.json
        ```
        
        * Make changes to ```regs.json```
        * Generate output artifacts:
        
        ```sh
        corsair -r regs.json --hdl --lb-bridge --docs
        ```
        
        * You will get:
          * Register map HDL code
          * Bridge to some standart interface (e.g. AXI-Lite, depends on configuration)
          * Document, describing the map
        
        For more details about ways the tool can be used and how it works please refer the documentation at [Read the docs](https://corsair.readthedocs.io).
        
        ## Installation
        
        You can install the latest release:
        
        ```sh
        python3 -m pip install -U corsair
        ```
        
        To get the latest development version:
        
        ```sh
        python3 -m pip install -U git+https://github.com/esynr3z/corsair.git
        ```
        
        Alternatively:
        
        ```sh
        git clone https://github.com/esynr3z/corsair.git
        cd corsair
        python3 setup.py install
        ```
        
        ## Development
        
        Corsair is still under development. Please follow the [Developers Guide](https://corsair.readthedocs.io/en/latest/contributing.html).
        
        ## License
        
        Corsair is licensed under [MIT License](LICENSE.txt).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
