Usage/user-facing documentation

greatscottgadgets / greatfet-tutorials

Learn to do something new with GreatFET!

https://greatscottgadgets.github.io/greatfet-tutorials/

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

61 stars 22 forks source link

Usage/user-facing documentation #15

Open ktemkin opened 5 years ago

ktemkin commented 5 years ago

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.

mossmann commented 5 years ago

start greatfet-tutorials repo and use gh-pages branch

Getting Started with GreatFET:

[x] install software (from release package for now)
[x] plug in GreatFET One and try command-line tools (start with gf info)
[ ] blink LED from command-line
[x] 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

ktemkin commented 5 years ago

converted the bullet point list here to use fancy github checkboxes

acecase commented 1 week ago

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.