From f359d4b3a8273a82470277ced42f58bc3d82d7ca Mon Sep 17 00:00:00 2001 From: Kelvin Chung Date: Mon, 26 Feb 2024 16:22:05 +0000 Subject: [PATCH] update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index af443ba4..23ae4e80 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,16 @@ Dirk Koch, Nguyen Dao, Bea Healy, Jing Yu, and Andrew Attwood. 2021. FABulous: A [Link to Paper](https://dl.acm.org/doi/pdf/10.1145/3431920.3439302) +``` +@inproceedings{koch2021fabulous, + title={FABulous: An embedded FPGA framework}, + author={Koch, Dirk and Dao, Nguyen and Healy, Bea and Yu, Jing and Attwood, Andrew}, + booktitle={The 2021 ACM/SIGDA International Symposium on Field-Programmable Gate Arrays}, + pages={45--56}, + year={2021} +} +``` + ## Prerequisites The following packages need to be installed for generating fabric HDL models and using the FABulous front end: @@ -90,3 +100,19 @@ The tool also supports using TCL script to drive the build process. Assuming you More details on bitstream generation can be found [here](https://fabulous.readthedocs.io/en/latest/FPGA-to-bitstream/Bitstream%20generation.html). Detailed documentation for the project can be found [here](https://fabulous.readthedocs.io/en/latest/index.html) + +## Contribution Guidelines + +Thank you for considering contributing to FABulous! By contributing, you're helping us improve and grow the project for everyone. Before you start, please take a moment to review our guidelines to ensure a smooth contribution process. + +### Code Formatting + +We use [Black](https://github.com/psf/black) for code formatting. Please make sure your code adheres to Black's standards before submitting a pull request. + +### Code Review + +Once you've submitted a pull request, one of our maintainers will review your code. Please be patient during this process. We may suggest changes or improvements to ensure the quality and compatibility of your contribution. + +### License + +By contributing to this project, you agree that your contributions will be licensed under the project's [License](https://opensource.org/licenses/Apache-2.0).