Skip to content

Commit e057fc9

Browse files
committed
[Docs] Update top level markdown files
Signed-off-by: auphelia <[email protected]>
1 parent 6226ab5 commit e057fc9

File tree

4 files changed

+58
-16
lines changed

4 files changed

+58
-16
lines changed

CHANGELOG.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,58 @@ Please follow the steps below and be sure that your contribution complies with o
2929
1. The <a href="https://github.com/Xilinx/finn" target="_blank">main branch</a> should always be treated as stable and clean. Only hot fixes are allowed to be pull-requested. The hot fix is supposed to be very important such that without this fix, a lot of things will break.
3030
2. For new features, smaller bug fixes, doc updates, and many other fixes, users should pull request against the <a href="https://github.com/Xilinx/finn/tree/dev" target="_blank">development branch</a>.
3131

32-
3. We will review your contribution and, if any additional fixes or modifications are
32+
3. ### 3. Sign Your Work
33+
34+
Please use the *Signed-off-by* line at the end of your patch which indicates that you accept the Developer Certificate of Origin (DCO) defined by https://developercertificate.org/ reproduced below::
35+
36+
```
37+
Developer Certificate of Origin
38+
Version 1.1
39+
40+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
41+
1 Letterman Drive
42+
Suite D4700
43+
San Francisco, CA, 94129
44+
45+
Everyone is permitted to copy and distribute verbatim copies of this
46+
license document, but changing it is not allowed.
47+
48+
49+
Developer's Certificate of Origin 1.1
50+
51+
By making a contribution to this project, I certify that:
52+
53+
(a) The contribution was created in whole or in part by me and I
54+
have the right to submit it under the open source license
55+
indicated in the file; or
56+
57+
(b) The contribution is based upon previous work that, to the best
58+
of my knowledge, is covered under an appropriate open source
59+
license and I have the right under that license to submit that
60+
work with modifications, whether created in whole or in part
61+
by me, under the same open source license (unless I am
62+
permitted to submit under a different license), as indicated
63+
in the file; or
64+
65+
(c) The contribution was provided directly to me by some other
66+
person who certified (a), (b) or (c) and I have not modified
67+
it.
68+
69+
(d) I understand and agree that this project and the contribution
70+
are public and that a record of the contribution (including all
71+
personal information I submit with it, including my sign-off) is
72+
maintained indefinitely and may be redistributed consistent with
73+
this project or the open source license(s) involved.
74+
```
75+
76+
Here is an example Signed-off-by line which indicates that the contributor accepts DCO::
77+
78+
```
79+
This is my commit message
80+
81+
Signed-off-by: Jane Doe <[email protected]>
82+
```
83+
84+
4. We will review your contribution and, if any additional fixes or modifications are
3385
necessary, may provide feedback to guide you. When accepted, your pull request will
3486
be merged to the repository. If you have more questions please contact us.

LICENSE.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
Copyright (c) 2020, Xilinx
1+
Copyright (C) 2020-2022, Xilinx, Inc.
2+
Copyright (C) 2022-2024, Advanced Micro Devices, Inc.
23
All rights reserved.
34

45
Redistribution and use in source and binary forms, with or without

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22

33

44

5-
<img align="left" src="https://raw.githubusercontent.com/Xilinx/finn/github-pages/docs/img/finn-stack.png" alt="drawing" style="margin-right: 20px" width="250"/>
5+
<img align="left" src="https://raw.githubusercontent.com/Xilinx/finn/github-pages/docs/img/finn-stack.PNG" alt="drawing" style="margin-right: 20px" width="250"/>
66

77
[![GitHub Discussions](https://img.shields.io/badge/discussions-join-green)](https://github.com/Xilinx/finn/discussions)
88
[![ReadTheDocs](https://readthedocs.org/projects/finn/badge/?version=latest&style=plastic)](http://finn.readthedocs.io/)
99

10-
FINN is an experimental framework from Xilinx Research Labs to explore deep neural network
11-
inference on FPGAs.
10+
FINN is an experimental framework from Integrated Communications and AI Lab of AMD Research & Advanced Development to explore deep neural network inference on FPGAs.
1211
It specifically targets <a href="https://github.com/maltanar/qnn-inference-examples" target="_blank">quantized neural
1312
networks</a>, with emphasis on
1413
generating dataflow-style architectures customized for each network.
@@ -28,7 +27,7 @@ Please see the [Getting Started](https://finn.readthedocs.io/en/latest/getting_s
2827

2928
## Documentation
3029

31-
You can view the documentation on [readthedocs](https://finn.readthedocs.io) or build them locally using `python setup.py doc` from inside the Docker container. Additionally, there is a series of [Jupyter notebook tutorials](https://github.com/Xilinx/finn/tree/main/notebooks), which we recommend running from inside Docker for a better experience.
30+
You can view the documentation on [readthedocs](https://finn.readthedocs.io). Additionally, there is a series of [Jupyter notebook tutorials](https://github.com/Xilinx/finn/tree/main/notebooks), which we recommend running from inside Docker for a better experience.
3231

3332
## Community
3433

0 commit comments

Comments
 (0)