Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CHARLIE_README.md #100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions CHARLIE_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,40 @@

Hi there! Welcome to the project. We're glad you're here.

# To initialize

``` bash
git clone https://github.com/meltylabs/melty
cd melty
yarn
git submodule init
```

# To run

Takes a minute or so

``` bash
yarn && yarn watch
```

Build with cmd+shift+b (or go to command palette and run build task)

``` bash
./scripts/code.sh
```

# To install latest spectacular

``` bash
./scripts/build-spectacular.sh
```

# To package
``` bash
yarn gulp vscode-darwin-arm64
```

# amateur's guide to react

1. Wrap rpc calls in useCallback. This one should not have empty dependency array (but don't omit it entirely, or it will run on every render!)
Expand Down