Commit Graph

9 Commits

Author SHA1 Message Date
Kevin Dewald
19dc2a403d Better READMEs and updated URLs (#385)
* New README

* Tweaks

* Tweaks

* Tweaks

* Tweaks

* Tweaks

* Updated old references
2025-01-26 19:03:52 -08:00
Tobías Lifschitz
22de7ed503 Misc doc changes (#323)
* [docs] Change CMake source flag in build documentation

From deprecated -H /path/to/source to -S /path/to/source

* [docs] Add class diagram to Simpleble 'API reference' page

Showing relationship between main frontend classes

* [docs] Add missing Cmake link

* Update api.rst

Removed class diagram. Doesn't seem necessary.

---------

Co-authored-by: Kevin Dewald <5274600+kdewald@users.noreply.github.com>
2024-07-06 11:18:36 -07:00
Kevin Dewald
1fed27d6fd Updated documentation 2023-02-21 21:27:54 -08:00
Kevin Dewald
dfe8ba9325 Fix incorrect logging logic 2023-02-05 20:09:35 -08:00
Kevin Dewald
60e087b0da Cleanup in preparation for v0.5.0 release. (#108)
* Add support to run Doxygen on SimpleBLE source code.

* Merged changelogs and dropped old messages.

* Added tutorial page

* Add tutorial to index

* Minor tweaks in changelog

* Initial tutorial

* Minor fixes

* Clean lint job, add docs build job

* Fix indentation error

* Fix indentation error, again...

* Doxygen now works fine

* Added a lot of documentation
2022-09-20 13:17:43 -07:00
Kevin Dewald
f107a59c37 Fix issue in CMakeLists forcing incorrect OSX deployment target (#96)
* Fixed issue in CMakeLists which forced incorrect OSX deployment target

* Add logs

* See if deployment target really needs to be defined

* Only set the target if none is set

* Remove unnecessary deployment target configuration. It should be passed in by the user.

* Fixed minor docs issues.
2022-09-06 10:58:54 -07:00
Kevin Dewald
232e81d193 Finalized documentation for a first pass. 2022-08-26 22:17:07 -07:00
Kevin Dewald
4133ae9b01 First complete pass at docs 2022-08-20 17:43:48 -07:00
Kevin Dewald
323edeb595 Basic documentation structure. 2022-08-20 12:39:56 -07:00