Add README for xkcd and xkcd-script

Open Beginner friendly
#57 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
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Locate the README files or documentation entry points for xkcd and xkcd-script, then read the existing project files and history for provenance and contribution context. Document the requested history for xkcd and explain how xkcd-script works and how contributors can participate; the README content should cover both areas clearly.

Written by the indexing model from the issue text.

Description

For xkcd, some provenance/history.

For xkcd-script, some background on how it works, and how to contribute etc.

Dominant language
Python
Stars
1.4k
Forks
49
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 ipython/xkcd-font

All issues in ipython/xkcd-font

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.