Add an examples index page

Open Beginner friendly
  • Is something wrong?
#232 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Inspect the existing .tp examples and note what each demonstrates. Create examples/README.md with a list of those examples and a brief description of each; done means every existing example is represented.

Written by the indexing model from the issue text.

Description

good first issue

Create a small examples/README.md that lists the existing .tp examples and briefly describes what each demonstrates.

Dominant language
Python
Stars
2
Forks
4
Avg merge
2d 16h
Merged PRs (30d)
9

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Sim20004/teapot-lang

All issues in Sim20004/teapot-lang

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.