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.

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

Latest documentation? #2

Open
annerajb opened this issue May 8, 2017 · 1 comment
Open

Latest documentation? #2

annerajb opened this issue May 8, 2017 · 1 comment

Comments

@annerajb
Copy link

annerajb commented May 8, 2017

Where can I find the latest sdk documentation?
The ones I can find online are from 2011.

@Marcus10110
Copy link
Contributor

I'm in the process of updating the documentation now.

There are 2 main parts - everything involved in getting setup, building & debugging, and the API documentation itself.

I've finished updating and migrating the setup documentation, it's in the SampleAnalyzer repository here:
https://github.com/saleae/SampleAnalyzer/blob/master/docs/Analyzer%20SDK%20Setup.md

The API documentation itself hasn't been migrated yet, but the older documentation is in the SampleAnalyzer repository here:
https://github.com/saleae/SampleAnalyzer/blob/master/docs/Saleae%20Analyzer%20SDK%20(older).pdf

The first half that document covers setup, and it's obsolete - the markdown linked above replaces it.

The second half, the API documentation, is almost completely still correct - very few parts of the API have changed since that document was updated. However I still need to migrate it to markdown, and make a few corrections, and update it to include documentation of the protocol search results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants