Skip to content

Change readme to Markdown, correct formatting and add small desc #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ianfhunter wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Change readme to Markdown, correct formatting and add small desc #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!--
SPDX-License-Identifier: MIT
Copyright (C) 2022 Xilinx, Inc.
Copyright (C) 2022-2025 Advanced Micro Devices, Inc.
-->

# AIE API

AIE API is a portable programming interface for AIE accelerators. It is implemented as a C++ header-only library that provides types and operations that get translated into efficient low-level intrinsics.
The API also provides higher-level abstractions such as iterators and multi-dimensional arrays.

## Using AIE API in your application

Since AIE API is a header-only library, you only need to add the AIE API to your include path and include the corresponding header in your application.

`#include <aie_api/aie.hpp>`

## Documentation

View our [documentation site](https://xilinx.github.io/aie_api/).

You can also browse the Doxygen documentation under the doc folder.
24 changes: 0 additions & 24 deletions README.rst
View file
Open in desktop

This file was deleted.