Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PiterWeb authored Oct 9, 2024
1 parent f355ab9 commit ce364fc
Showing 1 changed file with 32 additions and 18 deletions.
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@

## Resources 📚

- [FAQ](https://remote-controller.vercel.app/info/resources/faq/)
- [Security](https://remote-controller.vercel.app/info/resources/security/)
- [Docs](./docs/) 📘
- [FAQ](https://remote-controller.vercel.app/info/resources/faq/) 💬
- [Security](https://remote-controller.vercel.app/info/resources/security/) 🔐

- https://github.com/user-attachments/assets/f4a412fa-f403-4429-85fb-9c1e74bff458

Expand Down Expand Up @@ -71,37 +72,50 @@ There is no way to self-host the infrastructure of RemoteController because it h

- Also you can host the Web version (but it is only frontend) to make like a network of Remote Controller web clients

## Build
## Run Dev

### Prerequisites

You must have Wails CLI, NodeJS, npm and Golang installed.
You must have Task CLI, Wails CLI, NodeJS, pnpm and Golang installed.

### How to

First go to the frontend folder and run
Go to the root project folder and run

`$ pnpm install`<br>
`$ pnpm run build`
- Full App :

Now run the following command on the root directory of the main project:
`$ task dev-all`

`$ wails build`
- Frontend:

finally go to the build/bin folder and your executable will be there.
`$ task dev-front`

> [!Note]
> Please note the supported platforms in the table
## Build

### Prerequisites

You must have Task CLI, Wails CLI, NodeJS, pnpm and Golang installed.

### How to

Go to the root project folder and run

- For general builds:

`$ task build`

## How it works 👷‍♂️
- For Windows builds:

This desktop APP is based on the WebRTC 🎞 standard and it uses the power of Go to communicate 🗣 with the Gamepad emulation libraries.
In Windows uses the ViGEm Bus Driver with the ViGEm Client DLL
`$ task build-win`

For the low level actions uses Go.
On the other hand the UI works with Web technologies (WASM, Sveltekit, Tailwind, DaisyUI & Typescript)
- For Linux builds:

You can learn more about [how it works](./docs/README.md) under the hood all the project
`$ task build-linux`

finally go to the build/bin folder and your executables will be there.

> [!Note]
> Please note the supported platforms in the table
## Contributting 🤝

Expand Down

0 comments on commit ce364fc

Please sign in to comment.