docs(installation): [closes #267] document cloning, NPM, and WSL
This commit is contained in:
parent
3adaf41ea0
commit
24ac1f1bcd
15
README.md
15
README.md
@ -156,7 +156,20 @@ As well as the following [standard `<iframe />` attributes](https://developer.mo
|
||||
- `referrerpolicy`
|
||||
- `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:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user