CURRENTLY NOT MAINTAINED
A device agnostic DFU library
- The main features of dfuller are:
- A
- B
- C
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
Give examples
$ cmake -S . -B build
$ cmake --build buildYou can find demonstrations on how to use the library in the demos folder.
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
$ cd build
$ ctestExplain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
Please read :ref:`CONTRIBUTING <CONTRIBUTING>` for details on our code of conduct, and the process for submitting pull requests to us.
This project uses clang-format to automatically format the code and keep a consistent code style. To use it, use the following command:
$ clang-format -i -style=file src/*.cpp include/*/*.hppWe use SemVer for versioning. To increment the version number use bump2version
$ bump2version majorThis increments the version from, e.g. 0.1.0 to 1.0.0 See .bumpversion.cfg for details on what happens.
See the list of :ref:`AUTHORS <AUTHORS>` to see who helped creating dfuller.
This project is licensed under the MIT license - see the :ref:`LICENSE <LICENSE>` file for details
This package was created with Cookiecutter and the nmusolino/cookiecutter-cpplib-tools project template.