Welcome, Prettier.
This commit is contained in:
18
README.md
18
README.md
@ -1,4 +1,5 @@
|
||||
# Colormatic Website
|
||||
|
||||
[colormatic.org](https://colormatic.org)
|
||||
|
||||
This project uses SvelteKit along with TypeScript and Sass. It's configured for static site generation (SSG) and prerendering at compile time to create a simple static website for Nginx to serve, with very little client-side rendering (CSR).
|
||||
@ -6,22 +7,37 @@ This project uses SvelteKit along with TypeScript and Sass. It's configured for
|
||||
The Colormatic website is developed with accordance to modern web standards, however a legacy website will be available in the future for older/less capable browsers.
|
||||
|
||||
To download the project, run:
|
||||
|
||||
```
|
||||
git clone git@git.colormatic.org:ColormaticStudios/Colormatic-Website.git
|
||||
cd Colormatic-Website
|
||||
npm install
|
||||
```
|
||||
|
||||
You can run the project locally with:
|
||||
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Or you can build the project for release with:
|
||||
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
||||
After the project has been built, you can preview the release build with:
|
||||
|
||||
```
|
||||
npm run preview
|
||||
```
|
||||
|
||||
Bootstrap Icons are licensed under the [MIT](https://opensource.org/license/MIT) license.
|
||||
Before submitting a push or pull request, run:
|
||||
|
||||
```
|
||||
npm run format
|
||||
```
|
||||
|
||||
To format your code according to the project code format. Remember to never fight the formatter.
|
||||
|
||||
[Bootstrap Icons](https://icons.getbootstrap.com/) are licensed under the [MIT](https://opensource.org/license/MIT) license.
|
||||
|
Reference in New Issue
Block a user