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

Usage/user-facing documentation #15

Open
ktemkin opened this issue Feb 15, 2019 · 3 comments
Open

Usage/user-facing documentation #15

ktemkin opened this issue Feb 15, 2019 · 3 comments
Assignees
Labels
documentation documentation improvement or addition

Comments

@ktemkin
Copy link

ktemkin commented Feb 15, 2019

There’s currently a dearth of user-facing documentation and guides for GreatFET. We should rectify this; and this is especially important as more hardware winds up in end-user hands.

The comments for this issue are probably a good place to ideate about things we might want to document / guides we might want to create.

@ktemkin ktemkin added the documentation documentation improvement or addition label Feb 15, 2019
@mossmann
Copy link
Member

mossmann commented Feb 15, 2019

start greatfet-tutorials repo and use gh-pages branch

Getting Started with GreatFET:

  • install software (from release package for now)
  • plug in GreatFET One and try command-line tools (start with gf info)
  • blink LED from command-line
  • blink LED from Python
  • next steps (pointers to other guides)

Logic Analysis:

  • gf logic example, write to VCD file and load in pulseview
  • (future) real-time sigrok example

SPI:

  • working with a SPI flash chip

I2C:

  • scan
  • I/O expander example

@mossmann mossmann self-assigned this Feb 15, 2019
@ktemkin
Copy link
Author

ktemkin commented Sep 17, 2019

converted the bullet point list here to use fancy github checkboxes

@straithe straithe transferred this issue from greatscottgadgets/greatfet Dec 6, 2022
@acecase
Copy link

acecase commented Nov 6, 2024

Please do get back to this. I've been tinkering with this device and it's impressive, but its biggest strength and Achille's heel is how it is basically a direct interface to a very capable chip with some great peripherals. The basics interfacing is built in to the library/tooling and it's nice, but there are cheaper options that do those things. We really need a lot more documentation to show off the capabilities of this thing, and I think it would take off. As it stands, there is very little out there officially and YouTube isn't filling the gaps for us. Please give some resources to education for this device. Please.

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

No branches or pull requests

3 participants