Commit Graph

26 Commits (6f4235a11b53dafae68b4f18f80c2f138e2938f4)

Author SHA1 Message Date
Jorge Marques be0e2809e9
docs: Use doctools (#1258)
The extensions have been moved to docs tools.
The source code is available at
https://github.com/analogdevicesinc/doctools
And is installed as before:
(cd docs ; pip install -r requirements.txt --upgrade)
Since the package is listed on the requirements.txt file.

Also, add index for library and projects

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-02-22 11:32:04 -03:00
Iulia Moldovan b45e7a7313 Replace other master branch references to main
* README.md
* adi_regmap_xcvr.txt
* build_hdl.rst
* hdl_coding_guideline.rst
* data_offload/README.md

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2024-01-16 16:48:45 +02:00
Jorge Marques 4d676ca25a
docs: Update README, misspelings, and improvements
Update docs instructions in the README.md to recommend building the libraries before generating the documentation.
Fix misspellings in the SPI Engines.
Use hashlib to gen the reproducible ids, so these elements won't be committed at every build in the gh-pages branch.
Get username from environment variable, to use in the symbolator local installation path, dismissing user interaction for this.
Use modelParameter to extract the type from ip-xact parameters without the format field, and improve formatting.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-10-06 09:23:50 -03:00
Jorge Marques 55d4215f45 README.md: header, docs info; docs: license, fixes
Add documentation info to the README.md
At adi_hdl_parser.py, filter "_signal_clock" and "_signal_reset"
pseudo buses from component.xml files, append them as description
in the ports table, in the format
"{Bus} [...] is synchronous to this {domain}".
Also, adds collapsible directive

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
stefan.raus 040d5732c7 README.md: Add link to boot partition files download link
Add in README.md how to use and from where to get already built boot files.

Signed-off-by: stefan.raus <stefan.raus@analog.com>
2021-12-07 14:42:42 +02:00
Istvan Csomortani aa070ef940 README.md: State the main purpose of the repository 2019-08-26 16:32:23 +03:00
Robin Getz 5794b67fe0 Update README.md
Promote support, and add a few more details.
2019-05-22 11:04:06 +03:00
István Csomortáni 46d1ae58e9
README: Fix a typo 2019-04-03 10:21:36 +03:00
Istvan Csomortani 63780f8179 README: Remove the Documentation section, it's redundant 2018-03-07 12:28:40 +00:00
Istvan Csomortani 48b2b034a5 README: General rework and add more embedded links to wiki
+ Add more links to wiki
  + Add a software section with link to no-OS and Linux
  + Change the 'Development flow' to 'Which branch should I use?'
  + Add a documentation section
2018-03-07 12:28:40 +00:00
Istvan Csomortani 2c726ce45a README: A generic README update 2018-03-07 12:28:40 +00:00
Istvan Csomortani 7b01cd9eca README.md: Update the README 2016-03-31 19:42:52 +03:00
Istvan Csomortani 10977e9589 README.md: Update Vivado's version number 2015-09-29 15:11:10 +03:00
Adrian Costina eaddde1ea4 README.md: Update to Quartus 15.0. Removed release candidate note 2015-08-13 11:55:23 +03:00
Istvan Csomortani 0f32b25fcc Update README.md
Add FPGA vendor names
2015-05-20 17:38:08 +03:00
Istvan Csomortani 74eb3cb11d Update README.md
Add section title Documentation and support
2015-05-20 17:17:23 +03:00
Istvan Csomortani 41d45b310f Update README.md
+ Add note about current status. 
+ Add links for tools.
+ Use embedded links
2015-05-20 10:20:53 +03:00
Istvan Csomortani e0f2ca8cdb README: Update Vivado version number, 2014.4.1 is the new supported version 2015-03-03 09:48:13 +02:00
Istvan Csomortani 8ccab473eb README.md: General update
/dev branch supports Vivado 2014.4
2015-01-29 12:46:19 +02:00
Istvan Csomortani d04f6fc61c README: Add tools version 2015-01-07 14:02:38 -05:00
Istvan Csomortani b185d46573 Add a link to EngineerZone
Some users find these projects through github, and they do not know how/where to ask support.
2014-04-15 10:25:18 +03:00
rejeesh kutty 4116247fc0 Update README.md 2014-04-04 16:30:28 -04:00
rejeesh kutty 8394532c12 Update README.md 2014-03-13 14:03:15 -04:00
rejeesh kutty 21d4c25586 Update README.md 2014-03-13 14:02:46 -04:00
rejeesh kutty 77ed085641 Update README.md 2014-03-10 16:41:22 -04:00
rejeesh kutty 64b7269288 Initial commit 2014-02-20 12:49:14 -08:00