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.

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

Update doc to reference requirement of libiio #111

Merged
merged 1 commit into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
This is a simple library used for userspace,
- which manages multi-chip sync (on platforms (FMCOMMS5) where multiple AD9361 devices are use)
- can create AD9361 specific FIR filters on the fly,


**Dependencies**

- [libiio IIO interface library (Version less than v1.0)](https://github.com/analogdevicesinc/libiio)

**Docs**

Doxygen-based documentation is available at: http://analogdevicesinc.github.io/libad9361-iio/
Expand Down
2 changes: 1 addition & 1 deletion bindings/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you have a question about libad9361-iio or the AD9361 transceiver please ask

## Requirements
To use these bindings naturally you need the core library they depend upon, libad9361-iio. This is not packaged with the pypi release but there are a number of options:
- If you want to just use libad9361-iio, we suggest using the [latest release](https://github.com/analogdevicesinc/libad9361-iio/releases/latest).
- If you want to just use libad9361-iio, we suggest using the [latest v0.XX release](https://github.com/analogdevicesinc/libad9361-iio/releases/latest) (v1.XX is not supported yet).
- If you think you have found a bug in the release, or need a feature which isn't in the release, try the latest **untested** binaries from the master branch and check out the [documentation](https://codedocs.xyz/analogdevicesinc/libad9361-iio/) based on the master branch. We provide builds for a few operating systems. If you need something else, we can most likely add that -- just ask.

### Installing the bindings
Expand Down
2 changes: 2 additions & 0 deletions mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ This is a simple library used for userspace management control and configuration
- which manages multi-chip sync (on platforms (FMCOMMS5) where multiple AD9361 devices are use)
- can create AD9361 specific FIR filters on the fly

The library requires:
- libiio version 0.X (>= 1.0.0 is not supported yet): http://analogdevicesinc.github.io/libiio/

@section ad9361_hardware AD9361 Transceiver Internals

Expand Down
Loading