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 README.md #34

Merged
merged 2 commits into from
Sep 2, 2024
Merged
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
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,33 @@ Download the Chrome Extension at https://chromewebstore.google.com/detail/dirpla

The extension implements a polyfill that replaces all `<embed>` elements that point to a Shockwave file in websites you visit.

## Installing dependencies
```bash
npm install
```

## Building Rust VM
## Requirements
- NodeJS
- - [(LTS or newer)](https://nodejs.org/)
- RustLang
- - [(1.70.0 or newer)](https://www.rust-lang.org/)
- wasm-pack
- - https://github.com/rustwasm/wasm-pack/releases

## Building
> [!NOTE]
> Before we can start, we need to load the missing modules for NodeJS with the `npm install` command.

### 🪟 Windows
Windows users can use our scripts which are located in the [`scripts`](https://github.com/igorlira/dirplayer-rs/tree/main/scripts) folder and end with `.bat`.
- Build Rust VM with [`scripts/build-vm.bat`](https://github.com/igorlira/dirplayer-rs/blob/main/scripts/build-vm.bat)
- Build extension with [`scripts/build-extension.bat`](https://github.com/igorlira/dirplayer-rs/blob/main/scripts/build-extension.bat)
- [Further information can be found here](https://github.com/igorlira/dirplayer-rs?tab=readme-ov-file#building-extension)
- Run locally with [`scripts/run.bat`](https://github.com/igorlira/dirplayer-rs/blob/main/scripts/run.bat)

### 🐧 Other platforms
#### Building Rust VM

```bash
npm run build-vm
```

## Building extension
#### Building extension

```bash
npm run build-extension
Expand All @@ -37,7 +52,7 @@ You can install the local build by going to `chrome://extensions`, enabling Deve

Note that the extension is currently only available on Chrome.

## Running locally
#### Running locally

```bash
npm run start
Expand Down