diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f49e78 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ + + +# 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 ` + +## Documentation + +View our [documentation site](https://xilinx.github.io/aie_api/). + +You can also browse the Doxygen documentation under the doc folder. diff --git a/README.rst b/README.rst deleted file mode 100644 index 743e454..0000000 --- a/README.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _README.rst: - -.. - comment:: SPDX-License-Identifier: MIT - comment:: Copyright (C) 2022 Xilinx, Inc. - comment:: Copyright (C) 2022-2025 Advanced Micro Devices, Inc. - -================================= -AIE API -================================= - -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 ` - -Documentation -============= - -View our documentation site: https://xilinx.github.io/aie_api/. - -You can also browse the Doxygen documentation under the doc folder.