Skip to content

Commit

Permalink
docs(README.md): update 'How to Contribute' section (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
wescopeland authored Feb 25, 2024
1 parent 83f863e commit 0020a64
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,23 @@ Click the function names to open their complete docs on the docs site.

## How to Contribute

TODO
First, fork this repository and clone your fork. Then, in a terminal, `cd` into the repo directory on your local machine.

### Installation

```bash
npm install
```

### Dev Server

```bash
npm run dev
```

You can now open your local docs site in your browser. By default, this can done by visiting http://localhost:5173/.

Put your work on a branch and push it to your fork. When you are ready to contribute to this repository, open a PR with your branch targeting this repo's `main`.

## Projects Using the RetroAchievements API

Expand Down

0 comments on commit 0020a64

Please sign in to comment.