glasgow icon indicating copy to clipboard operation
glasgow copied to clipboard
verified publisher icon GlasgowEmbedded

Documentation

Open attie opened this issue 2 years ago • 4 comments

I am planning to spend time writing more documentation for Glasgow, in preparation for the influx of new users via Crowd Supply.

I'm sharing my plans here, please feel free to comment with suggestions. This will reside in the /docs/ directory, and will not likely touch README.md, at least for now... it may absorb some of the content at some point. Some of these items will draw heavily on existing words.

The longer-term goal of this issue is to also produce static HTML that is hosted somewhere (probably using GitHub pages on a branch of this repo?)

  • [x] Index
    • [x] Intro - what is Glasgow & what can it do?
    • [x] Project overview
      • [x] Revisions & naming
  • [ ] Getting started
    • [ ] Installation
      • [x] Linux
        • [ ] Ubuntu 20.04 LTS
      • [x] macOS
      • [x] Windows
    • [ ] Running / invocation
      • [x] Overview
      • [x] Basic run Examples
      • [ ] REPL & Script usage
      • [ ] Built-in Analyzer
    • ~~Common problems & resolutions~~
  • [ ] Applets
    • [ ] Overview
    • [ ] Details
    • [ ] Out-of-tree applets (TBD...)
    • [ ] My first applet example / template / walkthrough
  • [x] Hardware variants
    • [x] Naming scheme
    • foreach
      • Feature summary
      • Board overview
  • [ ] Production
    • [ ] PCBs, BOM & Assembly
    • [x] Provisioning (serial numbers & firmware)
    • [ ] Testing
  • [ ] Internals
    • [ ] Boot
    • [ ] Communication (between FPGA and Python)
    • [ ] Applet build, load & run
    • probably much more, TBD...
  • [ ] Q&A
    • [ ] Where did the name come from?
    • [x] Where can I get one?
    • [x] Where can I ask for help?
    • [x] Where & how can I use it? (Licensing)

attie avatar Mar 30 '23 11:03 attie

Sounds wonderful! Let's gather on our IRC/Discord channel to discuss this sometime soon?

whitequark avatar Mar 31 '23 05:03 whitequark

Requested examples / expansion:

  • REPL usage (e.g: I2C bus scan & read/write)
  • Internal analyzer

attie avatar Sep 30 '23 22:09 attie

  • Add instructions for Ubuntu 20.04 LTS

attie avatar Oct 07 '23 23:10 attie

  • Add instructions for Ubuntu 20.04 LTS

These are really annoying--I've had a go and I think I won't be working on them.

https://github.com/GlasgowEmbedded/glasgow/issues/422#issuecomment-1752200586 includes a Docker-based reproducer, which will come in handy for anyone daring enough to try.

whitequark avatar Oct 08 '23 23:10 whitequark