Skip to content

Commit

Permalink
Fix format
Browse files Browse the repository at this point in the history
  • Loading branch information
Hacksore committed Nov 24, 2023
1 parent 611de38 commit 3582f30
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ running, please look at [LOCAL.md](/LOCAL.md) for setup instructions.

This project and everyone participating in it is governed by the
[Code of Conduct](/CODE_OF_CONDUCT.md). By
participating you are expected to uphold this code.
participating you are expected to uphold this code.

## I Want to Contribute

Expand Down
9 changes: 7 additions & 2 deletions LOCAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,24 @@
To contribute you will first need to fork the repo and make some adjustments to
get it up and running on your local machine. Below are the steps to follow for you to get Overlayed to run on your local machine.

# Perquisites
# Prerequisites

- Rust
- Node
- pnpm
- pnpm

### 1. Fork & clone the repo

Follow https://docs.github.com/en/get-started/quickstart/fork-a-repo

### 2. Install the deps

From the root of the monorepo run.

```
pnpm install
```

### 3. Start the desktop app

From the root of the monorepo run `pnpm start --filter=desktop`

0 comments on commit 3582f30

Please sign in to comment.