docs(README): Update README
All checks were successful
Deploy website to alys.phundrak.com / build (push) Successful in 20s

This commit is contained in:
Lucien Cartier-Tilet 2024-06-28 06:15:05 +02:00
parent e3f21a252b
commit 2b00f590c3
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA

View File

@ -1,19 +1,22 @@
# ALYS Vocal Libraries Website
## Installing dependencies
To run the website, you will need corepacks yarn 4. You can enable it
using `yarn set version stable`, or you can enter a Nix shell using
`nix-shell` at the root of this repository.
To run the website, you will need the NPM package manager. You can
either install it following your operating systems workflow, or you
can enter a Nix shell using `nix-shell` at the root of this
repository. If you run `direnv allow .` at the root of this
repository, the Nix shell made for this project will be loaded
automatically.
To install all dependencies, run the following command:
```sh
yarn
npm install
```
## Running the website
To run the website in development mode, run the following command:
```sh
yarn dev
npm run dev
```
This will start the website at <http://localhost:5173>.
@ -21,12 +24,12 @@ This will start the website at <http://localhost:5173>.
## Building the website
To build the website, run the following command:
```sh
yarn build
npm run build
```
You can view this release build by running the following command:
```sh
yarn preview
npm run preview
```
# License