Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: ad2s1210: Update readme file and doc #116

Merged
merged 1 commit into from
Jan 20, 2025
Merged

doc: ad2s1210: Update readme file and doc #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/sphinx/source/projects/ad2s1210_iio/ad2s1210_iio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ SDP-K1 board using the Arduino connector.

The connections are as follows:
+-------------+------------+
| SDPK1 | BREAKOUT |
| SDPK1 | BREAKOUT |
+-------------+------------+
| DIGITAL-0 | 96 A0 |
+-------------+------------+
Expand Down
4 changes: 2 additions & 2 deletions projects/ad2s1210_iio/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use of the Mbed platform allows code to be ported to other Mbed supported target

Product details: AD2S1210.
Product Evaluation board details: EVAL-AD2S1210SDZ
User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/AD2S1210_mbed_iio_support
User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad2s1210_iio/ad2s1210_iio.html
Comment on lines 12 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we really need the readme?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the projects added before GH docs have the readme files. Discussed the same with @gprasadbng, and decided to leave it as is for older projects fixing the broken links.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, should we update all the wiki links in this readme?
There is another link that points to wiki in line-54 "Find detailed instructions here...."

Communication Protocol: SPI


Expand Down Expand Up @@ -51,7 +51,7 @@ How to Get Started
Mbed web/online compiler: https://studio.keil.arm.com/auth/login/
Import the code into the compiler and compile it to generate the executable binary file.
Drag and drop the binary file onto the USB drive hosted by the SDP-K1 controller board.
Find detailed instructions here: https://wiki.analog.com/resources/tools-software/product-support-software/pcg-fw-mbed-build-guide
Find detailed instructions here: https://analogdevicesinc.github.io/precision-converters-firmware/source/build/project_build.html


Notes
Expand Down
Loading