mirror of
https://github.com/Equicord/Equicord.git
synced 2025-06-07 13:43:03 -04:00
change readme(s)
This commit is contained in:
parent
7e0ff9b0da
commit
38d2f9c265
4 changed files with 16 additions and 14 deletions
24
README.md
24
README.md
|
@ -240,14 +240,19 @@ sh -c "$(curl -sS https://raw.githubusercontent.com/Equicord/Equicord/refs/heads
|
|||
|
||||
### 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`:
|
||||
|
||||
> :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.
|
||||
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.
|
||||
|
||||
**On macOS and Linux:**
|
||||
```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.
|
||||
|
@ -260,21 +265,18 @@ cd Equicord
|
|||
```
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```shell
|
||||
pnpm install --no-frozen-lockfile
|
||||
bun install
|
||||
```
|
||||
|
||||
Build Equicord:
|
||||
|
||||
```shell
|
||||
pnpm build
|
||||
bun run build
|
||||
```
|
||||
|
||||
Inject Equicord into your client:
|
||||
|
||||
```shell
|
||||
pnpm inject
|
||||
bun run inject
|
||||
```
|
||||
|
||||
## Credits
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
# How to publish
|
||||
|
||||
1. run `pnpm generateTypes` in the project root
|
||||
1. run `bun generateTypes` in the project root
|
||||
2. bump package.json version
|
||||
3. npm publish
|
||||
|
|
|
@ -7,5 +7,5 @@ npm i @vencord/types
|
|||
|
||||
yarn add @vencord/types
|
||||
|
||||
pnpm add @vencord/types
|
||||
bun add @vencord/types
|
||||
```
|
||||
|
|
|
@ -61,7 +61,7 @@ export default definePlugin({
|
|||
|
||||
start() {
|
||||
// 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();
|
||||
},
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue