Add README

Open Beginner friendly
#33 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
jekyll
Domain
documentation

Research direction

Create a README explaining how to clone the repository and run the project locally, including the Jekyll instructions. Start by checking the repository's current Jekyll setup and local run command. Done means a newcomer can follow the README from cloning through running the project.

Written by the indexing model from the issue text.

Description

A simple README should be added, explaining how to locally clone the repository and run the project locally (jekyll instructions etc)

Dominant language
SCSS
Stars
29
Forks
10
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 gbdev/gb-opcodes

All issues in gbdev/gb-opcodes

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.