Shiloh/remnantchat
Shiloh/remnantchat
1
0
Fork 1
Code Issues Pull Requests Packages Projects 4 Releases Wiki Activity

docs(installation): [closes #267] document cloning, NPM, and WSL

Browse Source
This commit is contained in:
Jeremy Kahn 2024-04-21 21:04:04 -05:00
parent 3adaf41ea0
commit 24ac1f1bcd
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -156,7 +156,20 @@ As well as the following [standard `<iframe />` attributes](https://developer.mo
- `referrerpolicy` - `referrerpolicy`
- `sandbox` - `sandbox`
## Available Scripts ## Developing Chitchatter
> [!IMPORTANT]
> Presently Chitchatter can only be developed on \*NIX systems such as Linux and macOS. If you are using Windows, you can use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to set up a Linux environment.
To make changes to Chitchatter, clone the source code from GitHub. Ensure you have [Node and NPM](https://nodejs.org) installed. Then in the project directory, run:
```
npm install
```
This will install all of the dependencies.
### Available Scripts
In the project directory, you can run: In the project directory, you can run: