docs(rewrite): Add documentation for setup.mjs

This commit is contained in:
tecc 2023-08-31 21:40:41 +02:00
parent 5ead881f09
commit b2c43f084b
No known key found for this signature in database
GPG Key ID: 622EEC5BAE5EBD3A

View File

@ -4,6 +4,14 @@ This is the working directory for the Pronouns.page rewrite.
## Development environment
### `setup.mjs`
Run `setup.mjs` for a quick setup. It'll symlink some directories and will work as the equivalent of `make switch` et al.
The reason for making this a script is that make was causing problems for Windows users.
This script does not yet depend on a package manager, so you're free to use whatever you like, provided it'll play nice
with the remaining setup.
### Package managers
pnpm should work without any prior setup.