diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a83903c..508be5b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -33,7 +33,10 @@ jobs: else echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT fi - + - name: Delete pre-existing tag (if any) + run: | + git tag -d ${{ env.RELEASE_TAG }} || true + git push origin :refs/tags/${{ env.RELEASE_TAG }} || true - name: Create Release id: create_release uses: actions/create-release@v1 diff --git a/README.md b/README.md index cf02eed..3a88f6a 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,13 @@ # libdoip -[![CI/CD Pipeline](https://github.com/Magolves/libdoip/actions/workflows/ci.yml/badge.svg)](https://github.com/Magolves/libdoip/actions/workflows/ci.yml) -[![Release](https://github.com/Magolves/libdoip/actions/workflows/release.yml/badge.svg)](https://github.com/Magolves/libdoip/actions/workflows/release.yml) -[![License](https://img.shields.io/github/license/Magolves/libdoip)](LICENSE) -[![C++17](https://img.shields.io/badge/C%2B%2B-17-blue.svg)](https://isocpp.org/std/the-standard) -[![CMake](https://img.shields.io/badge/CMake-3.15+-blue.svg)](https://cmake.org/) -[![doctest](https://img.shields.io/badge/Tests-doctest-green.svg)](https://github.com/doctest/doctest) +**CAUTION** This repo is no longer active and will be deleted in the next weeks. -C/C++ library for Diagnostics over IP (DoIP) (fork from [https://github.com/AVL-DiTEST-DiagDev/libdoip](https://github.com/AVL-DiTEST-DiagDev/libdoip)) +Since the code changed significantly and the fork evolved into a different direction than originally anticipated, the work +is continued in repo [doip-server](), focusing on **server-side DoIP implementation** rather than client functionality. -**CAUTION** The current API is under construction any may change at any time. +## Current Status -## Dependencies - -`libdoip` uses `spdlog`. The lib is downloaded automatically. Or you may install it locally via - -```bash -# Install Doxygen and Graphviz -sudo apt install libspdlog-dev -``` - -See [Logging](./doc/LOGGING.md) for details. - -### Getting started - -Quick start — read the generated tutorial for the example server: - -- Online (published): [https://magolves.github.io/libdoip/index.html](https://magolves.github.io/libdoip/index.html) -- Local example page: see `doc/ExampleDoIPServer.md` (included in the Doxygen HTML under "Example DoIP Server Tutorial"). -- Example tutorial (direct): [https://magolves.github.io/libdoip/md_doc_ExampleDoIPServer.html](https://magolves.github.io/libdoip/md_doc_ExampleDoIPServer.html) - -If you want to generate the docs locally, install Doxygen and Graphviz and -run: - -```bash -sudo apt install doxygen graphviz -doxygen Doxyfile -xdg-open docs/html/index.html -``` - -### Installing library for Diagnostics over IP - -1. To install the library on the system, first get the source files with: - -```bash -git clone https://github.com/Magolves/libdoip.git -``` - -1. Enter the directory 'libdoip' and build the library with: - -```bash -cmake . -Bbuild -cd build -make -``` - -1. To install the library into `/usr/lib/libdoip` use: - -```bash -sudo make install -``` - -### Installing doctest - -```bash -sudo apt install doctest -``` - -## Debugging - -### Dump UDP - -```bash -sudo tcpdump -i any udp port 13400 -X -``` - -## Examples - -The project includes a small example DoIP server demonstrating how to -use the `DoIPServer` and `DoIPServerModel` APIs and how to register UDS -handlers. - -- Example source files: `examples/exampleDoIPServer.cpp`, - `examples/ExampleDoIPServerModel.h` -- Example tutorial: [https://magolves.github.io/libdoip/ExampleDoIPServer.html](https://magolves.github.io/libdoip/ExampleDoIPServer.html) - -See the "Examples" section in the generated Doxygen main page for -additional annotated links to these files. - -## References - -- [ISO 13400-2:2019(en) Road vehicles — Diagnostic communication over Internet Protocol (DoIP) — Part 2: Transport protocol and network layer services]() -- [Specification of Diagnostic over IP]() -- [Diagnostics over Internet Protocol (DoIP)]() +- **Repository:** [Magolves/doip-server](https://github.com/Magolves/doip-server) +- **Focus:** ISO 13400-2 DoIP Server implementation in C++17 +- **Original Fork:** No longer maintained ([libdoip](https://github.com/Magolves/libdoip)) +- **License:** Apache 2.0 (retained from original project)