Improve user documentation

AdaCore / Ada_Drivers_Library

Ada source code and complete sample GNAT projects for selected bare-board platforms supported by GNAT.

BSD 3-Clause "New" or "Revised" License

240 stars 141 forks source link

Improve user documentation #198

Open embeddedden opened 7 years ago

embeddedden commented 7 years ago

Hello, is it possible to provide some documentation for the library? I tried to launch an SPI on stm32f4-discovery board, but I wasn't succeed. And I don't know, how the library should be used. I saw several examples, but they are not enough for a beginner in Ada to start using this library.

Fabien-Chouteau commented 7 years ago

Hello,

The library is clearly lacking documentation right now.

What I would recommend is having a look at the driver examples/demo or other parts of the library where we already use the features that you are looking for.

For instance there's a example of SPI initialization in the STM32F429 board support: here.

We also have this Design document to provides a short overview of the library.

Regards,