Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve user documentation #198

Open
embeddedden opened this issue Jun 3, 2017 · 1 comment
Open

Improve user documentation #198

embeddedden opened this issue Jun 3, 2017 · 1 comment
Labels
enhancement

Comments

@embeddedden
Copy link

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
Copy link
Member

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,

@Fabien-Chouteau Fabien-Chouteau changed the title Can't find any documentation Improve user documentation Jun 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@embeddedden @Fabien-Chouteau