Skip to content

Commit

Permalink
Add Citation Info
Browse files Browse the repository at this point in the history
  • Loading branch information
Teddy-van-Jerry committed Oct 10, 2023
1 parent b66306a commit e1f4f11
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 1 deletion.
52 changes: 52 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
cff-version: 1.2.0
message: "If you find FLAMES useful in your research, please cite it as below."
authors:
- family-names: Zhao
given-names: Wuqiong
orcid: https://orcid.org/0000-0002-9550-7423
- family-names: Li
given-names: Changhan
- family-names: Ji
given-names: Zhenhao
- family-names: Guo
given-names: Zhichen
- family-names: Chen
given-names: Xuanbo
- family-names: You
given-names: You
- family-names: Huang
given-names: Yongming
- family-names: You
given-names: Xiaohu
- family-names: Zhang
given-names: Chuan
title: FLAMES
version: 0.1.0
license: Apache-2.0
date-released: 2023-07-10
url: https://github.com/autohdw/flames
preferred-citation:
type: article
authors:
- family-names: Zhao
given-names: Wuqiong
orcid: https://orcid.org/0000-0002-9550-7423
- family-names: Li
given-names: Changhan
- family-names: Ji
given-names: Zhenhao
- family-names: Guo
given-names: Zhichen
- family-names: Chen
given-names: Xuanbo
- family-names: You
given-names: You
- family-names: Huang
given-names: Yongming
- family-names: You
given-names: Xiaohu
- family-names: Zhang
given-names: Chuan
title: Flexible High-Level Synthesis Library for Linear Transformations
date-released: 2023-10-10
journal: "IEEE Transactions on Circuits and Systems II: Express Briefs"
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ Flexible Linear Algebra with Matrix-Empowered Synthesis (for Vitis HLS)
Developed by [Wuqiong Zhao](https://wqzhao.org) and other contributors,
from LEADS, Southeast University.

If you find FLAMES useful, please cite our paper.
```bibtex
@article{flames_hls,
title = {Flexible High-Level Synthesis Library for Linear Transformations},
author = {Zhao, Wuqiong and Li, Changhan and Ji, Zhenhao and Guo, Zhichen and Chen, Xuanbo and You, You and Huang, Yongming and You, Xiaohu and Zhang, Chuan},
journal = {IEEE Transactions on Circuits and Systems II: Express Briefs},
year = {2023},
published = {IEEE},
note = {to be published}
}
```

## Supported Versions
Since FLAMES is a modern library written using C++14 (with some C++17 features),
it only supports Vitis HLS 2020 or later where the CCC compiler version is 6.2.0.
Expand All @@ -12,7 +24,7 @@ Notably, Vivado HLS is not supported.
## Usage
FLAMES is a **header-only** library, so you can easily use it by first cloning it
under you project root with
```
```shell
git clone https://github.com/autohdw/flames.git
```

Expand Down

0 comments on commit e1f4f11

Please sign in to comment.