From 073739105e17a4697823b0c1c398fc40d11b031c Mon Sep 17 00:00:00 2001 From: AlexandraTrifan Date: Mon, 29 Jan 2024 15:38:00 +0200 Subject: [PATCH] README:Update README files and prepare the repo for the new default branch. Change all the links to point to the new default branch and remove unused appveyor status badge. Signed-off-by: AlexandraTrifan --- CI/ubuntu/doxygen.sh | 6 +++--- README.md | 17 +++++++++++++---- bindings/python/README.md | 8 +++----- doc/mainpage.dox | 2 +- doc/sphinx/source/examples.rst | 2 +- 5 files changed, 21 insertions(+), 14 deletions(-) diff --git a/CI/ubuntu/doxygen.sh b/CI/ubuntu/doxygen.sh index 5e66a5dc..f6033bc6 100755 --- a/CI/ubuntu/doxygen.sh +++ b/CI/ubuntu/doxygen.sh @@ -17,10 +17,10 @@ pushd ${TOP_DIR}/build echo_green "Documentation was generated successfully!" ############################################################################ -# If the current build is not a pull request and it is on master the +# If the current build is not a pull request and it is on the default branch the # documentation will be pushed to the gh-pages branch ############################################################################ -if [[ "${IS_PULL_REQUEST}" == "False" && "${BRANCH_NAME}" == "master" ]] +if [[ "${IS_PULL_REQUEST}" == "False" && "${BRANCH_NAME}" == "main" ]] then echo_green "Running Github docs update on commit '$CURRENT_COMMIT'" git config --global user.email "cse-ci-notifications@analog.com" @@ -59,5 +59,5 @@ then echo_green "Documentation already up to date!" fi else - echo_green "Documentation will be updated when this commit gets on master!" + echo_green "Documentation will be updated when this commit gets on the default branch!" fi diff --git a/README.md b/README.md index 2b165dd5..f6e90c19 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ -[![Linux Status](https://dev.azure.com/AnalogDevices/M2k/_apis/build/status/analogdevicesinc.libm2k?branchName=master)](https://dev.azure.com/AnalogDevices/M2k/_build/latest?definitionId=17&branchName=master) -[![Windows status](https://ci.appveyor.com/api/projects/status/88c4emamq2mg7c57/branch/master?svg=true)](https://ci.appveyor.com/project/analogdevicesinc/libm2k/branch/master) - ![libm2k logo](doc/img/libm2k_logo.png) +## Important note (January 2024) + +This version is compatible with libiio v0.25 or older - [libiio-v0](https://github.com/analogdevicesinc/libiio/tree/libiio-v0) + # libm2k Library for interfacing with the ADALM2000. More information available at https://wiki.analog.com/libm2k. -Windows builds available at https://ci.appveyor.com/project/analogdevicesinc/libm2k + + +[[Docs](http://analogdevicesinc.github.io/libm2k)] +[[Support](https://ez.analog.com/adieducation/university-program)] +[[Github](https://github.com/analogdevicesinc/libm2k/issues)] +[[Wiki](https://wiki.analog.com/libm2k)] + +## Installing +You can install the [latest release](https://github.com/analogdevicesinc/libm2k/releases/latest) or use the latest **untested** binaries from the default branch: [![default branch](https://dev.azure.com/AnalogDevices/M2k/_apis/build/status/analogdevicesinc.libm2k?branchName=main)](https://dev.azure.com/AnalogDevices/M2k/_build/latest?definitionId=17&branchName=main) diff --git a/bindings/python/README.md b/bindings/python/README.md index fb06bc1d..7965f6e8 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -5,15 +5,13 @@ This package contains the python bindings for libm2k. libm2k is a C++ library for interfacing with the ADALM2000, splitted into more correlated components, interconnected by a context. -[![Linux Status](https://dev.azure.com/AnalogDevices/M2k/_apis/build/status/analogdevicesinc.libm2k?branchName=master)](https://dev.azure.com/AnalogDevices/M2k/_build/latest?definitionId=17&branchName=master) -[![Windows status](https://ci.appveyor.com/api/projects/status/88c4emamq2mg7c57/branch/master?svg=true)](https://ci.appveyor.com/project/analogdevicesinc/libm2k/branch/master) - [[Docs](https://analogdevicesinc.github.io/libm2k/python/html/sphinx/build/html/index.html)] -[[Support](http://ez.analog.com)] +[[Support](https://ez.analog.com/adieducation/university-program)] +[[Github](https://github.com/analogdevicesinc/libm2k/issues)] [[Wiki](https://wiki.analog.com/libm2k)] ## Requirements -To use these bindings you need the core C++ library they depend upon. This is not packaged with the pypi release but you can install the [latest release](https://github.com/analogdevicesinc/libm2k/releases/latest) or the latest **untested** binaries from the [master branch](https://ci.appveyor.com/project/analogdevicesinc/libm2k). +To use these bindings you need the core C++ library they depend upon. This is not packaged with the pypi release but you can install the [latest release](https://github.com/analogdevicesinc/libm2k/releases/latest) or the latest **untested** binaries from the [![default branch](https://dev.azure.com/AnalogDevices/M2k/_apis/build/status/analogdevicesinc.libm2k?branchName=main)](https://dev.azure.com/AnalogDevices/M2k/_build/latest?definitionId=17&branchName=main) ### Installing You can install these bindings using pip, if you already have the library installed: diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 3088d209..b24ca769 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -55,7 +55,7 @@ There are multiple examples provided for libm2k and can be found on the Github [libm2k examples] page. The examples are created to ease the work for a libm2k user. To get familiar with libm2k API, the examples can be modified and built out of the libm2k source code tree by keeping the CMake configuration file provided for each example. -[libm2k examples]: https://github.com/analogdevicesinc/libm2k/tree/master/examples "libm2k official Github page" +[libm2k examples]: https://github.com/analogdevicesinc/libm2k/tree/main/examples "libm2k official Github page" ~~~{.cpp} // This example will generate a binary counter on the first N_BITS of the diff --git a/doc/sphinx/source/examples.rst b/doc/sphinx/source/examples.rst index 57518577..1ae81672 100644 --- a/doc/sphinx/source/examples.rst +++ b/doc/sphinx/source/examples.rst @@ -68,4 +68,4 @@ Generating data using the ADALM2000 DAC and acquiring it using the ADALM2000 ADC libm2k.contextClose(ctx) -Other Python examples are available in the `source repository `_ +Other Python examples are available in the `source repository `_