From bbda8d0e862a3e0f27ad7fd379c6a88d8851fd0f Mon Sep 17 00:00:00 2001 From: Nofated095 Date: Sat, 13 May 2023 15:59:49 +0800 Subject: [PATCH] Update README --- README.md | 39 ++++++++++++--------------------------- 1 file changed, 12 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index e3036bf..7d1f064 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,24 @@ -# Material UI - Vite.js in Typescript example +# nof.moe Project +###### Material UI, Vite.js, and Typescript. -## How to use -Download the example [or clone the repo](https://github.com/mui/material-ui): - +## Dev ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-vite-ts -cd material-vite-ts +git clone https://github.com/Nofated095/nof.moe.git +cd nof.moe +yarn +yarn dev ``` -Install it and run: +## The idea behind the project -```sh -npm install -npm run dev -``` - -or: - - - -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/material-vite-ts) - -[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/material-vite-ts) - -## The idea behind the example - -This example uses [Vite.js](https://github.com/vitejs/vite). +- This project uses [Vite.js](https://github.com/vitejs/vite). It includes `@mui/material` with `@mui/icons-material` and their peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5. -## What's next? +- This project is a rewrite for [Nofated095/nofated.win](https://github.com/Nofated095/nofated.win). Although it used to have a shit and large HTML & CSS & JS code with a low performance on browser, but the design is disreable so that the nof.moe is still using the style. - +## LICENSE -You now have a working example project. -You can head back to the documentation, continuing browsing it from the [templates](https://mui.com/material-ui/getting-started/templates/) section. +The project is under MIT Licence