mirrors/Equicord
1
1
Fork 0
mirror of https://github.com/Equicord/Equicord.git synced 2025-06-07 21:53:04 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

change readme(s)

Browse source
This commit is contained in:
creations 2025-06-04 10:56:49 -04:00
parent 7e0ff9b0da
commit 38d2f9c265
No known key found for this signature in database
GPG key ID: 8F553AA4320FC711
4 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -240,14 +240,19 @@ sh -c "$(curl -sS https://raw.githubusercontent.com/Equicord/Equicord/refs/heads
### Dependencies ### Dependencies
[Git](https://git-scm.com/download) and [Node.JS LTS](https://nodejs.dev/en/) are required. [Git](https://git-scm.com/download) and [Bun](https://bun.sh/docs/installation) are required.
Install `pnpm`: Install Bun:
> :exclamation: This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for Bun to be in your PATH.
> :exclamation: This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for pnpm to be in your PATH.
**On macOS and Linux:**
```shell ```shell
npm i -g pnpm curl -fsSL https://bun.sh/install | bash
```
**On Windows:**
```shell
powershell -c "irm bun.sh/install.ps1 | iex"
``` ```
> :exclamation: **IMPORTANT** Make sure you aren't using an admin/root terminal from here onwards. It **will** mess up your Discord/Equicord instance and you **will** most likely have to reinstall. > :exclamation: **IMPORTANT** Make sure you aren't using an admin/root terminal from here onwards. It **will** mess up your Discord/Equicord instance and you **will** most likely have to reinstall.
@ -260,21 +265,18 @@ cd Equicord
``` ```
Install dependencies: Install dependencies:
```shell ```shell
pnpm install --no-frozen-lockfile bun install
``` ```
Build Equicord: Build Equicord:
```shell ```shell
pnpm build bun run build
``` ```
Inject Equicord into your client: Inject Equicord into your client:
```shell ```shell
pnpm inject bun run inject
``` ```
## Credits ## Credits

2
packages/vencord-types/HOW2PUB.md
View file

@ -1,5 +1,5 @@
# How to publish # How to publish
1. run `pnpm generateTypes` in the project root 1. run `bun generateTypes` in the project root
2. bump package.json version 2. bump package.json version
3. npm publish 3. npm publish

2
packages/vencord-types/README.md
View file

@ -7,5 +7,5 @@ npm i @vencord/types
yarn add @vencord/types yarn add @vencord/types
pnpm add @vencord/types bun add @vencord/types
``` ```

2
src/plugins/devCompanion.dev/index.tsx
View file

@ -61,7 +61,7 @@ export default definePlugin({
start() { start() {
// if we're running the reporter, we need to initws in the reporter file to avoid a race condition // if we're running the reporter, we need to initws in the reporter file to avoid a race condition
if (!IS_DEV) throw new Error("This plugin requires dev mode to run, please build with pnpm build --dev"); if (!IS_DEV) throw new Error("This plugin requires dev mode to run, please build with bun build --dev");
initWs(); initWs();
}, },