bslathi19/PeakRDL-BusDecoder
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation to use correct repository name PeakRDL-BusDecoder and clarify project purpose (#7)

Browse Source 
* Initial plan

* Update documentation to use correct repository name PeakRDL-BusDecoder

Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com>

* Update CONTRIBUTING.md and GitHub templates with correct repository name

Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com>

* Update author to arnavsacheti and clarify bus decoder purpose in documentation

Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com>

* Update author to 'Arnav Sacheti' and revise UDP documentation to reflect no current UDP support

Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com>
This commit is contained in:
Copilot
2025-10-23 23:23:10 -07:00
committed by GitHub
parent 8cfd2a86c1
commit 6489f49873
21 changed files with 116 additions and 739 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/licensing.rst
View File

@@ -1,9 +1,9 @@
Licensing
=========
Re-distribution of the PeakRDL-busdecoder code generator tool shall adhere to the
Re-distribution of the PeakRDL-BusDecoder code generator tool shall adhere to the
terms outlined by the GNU LGPL v3 license. For a copy of the license, see:
https://github.com/arnavsacheti/PeakRDL-busdecoder/blob/main/LICENSE
https://github.com/arnavsacheti/PeakRDL-BusDecoder/blob/main/LICENSE
Why LGPLv3?
@@ -23,19 +23,19 @@ explicitly mentioned in the exemptions below.
What is exempt from the LGPLv3 license?
---------------------------------------
Don't worry. Not everything that the PeakRDL-busdecoder project touches is
Don't worry. Not everything that the PeakRDL-BusDecoder project touches is
considered LGPLv3 code.
The following are exempt and are free to use with no restrictions:
* Any code that is generated using PeakRDL-busdecoder is 100% yours. Since it
* Any code that is generated using PeakRDL-BusDecoder is 100% yours. Since it
was derived from your busdecoder definition, it remains yours. You can
distribute it freely, use it in a proprietary ASIC, sell it as part of an
IP, whatever.
* Any code snippets in this documentation can be freely copy/pasted. These are
examples that are intended for this purpose.
* All reference files that are downloadable from this documentation, which are
also available in the `hdl-src folder in the repository <https://github.com/arnavsacheti/PeakRDL-busdecoder/tree/main/hdl-src>`_
also available in the `hdl-src folder in the repository <https://github.com/arnavsacheti/PeakRDL-BusDecoder/tree/main/hdl-src>`_
Can I use this as part of my company's internally developed tools?