Skip to content

[DOCS] Add a terminal demo GIF to the README #31

@chahe-dridi

Description

@chahe-dridi

Docs: Demo GIF

The README has a plain text demo block. A real GIF would make it much more attractive.

What we need

A recording of:

  1. Running npx vscode-setup
  2. Picking 1-2 categories
  3. Selecting extensions
  4. Seeing install progress

Free tools

  • asciinema.org - records and shares as animated SVG
  • terminalizer.com - exports to GIF
  • github.com/charmbracelet/vhs - script your recording

How to contribute

  1. Record the demo
  2. Add to docs/assets/demo.gif
  3. Replace the text demo section in README.md with ![Demo](docs/assets/demo.gif)
  4. Open a PR

No coding required!

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions